Uses of Class
fj.Equal

Packages that use Equal

Package	Description
fj	Types that set the premise for the existence of Functional Java.
fj.data	Common algebraic data types.
fj.data.hamt
fj.function	A prelude of commonly used first-class functions

Uses of Equal in fj

Fields in fj declared as Equal

Modifier and Type	Field	Description
static final Equal<BigDecimal>	Equal.bigdecimalEqual	An equal instance for the BigDecimal type.
static final Equal<BigInteger>	Equal.bigintEqual	An equal instance for the BigInteger type.
static final Equal<BitSet>	Equal.bitSetSequal	An equal instance for the BitSet type.
static final Equal<Boolean>	Equal.booleanEqual	An equal instance for the boolean type.
static final Equal<Byte>	Equal.byteEqual	An equal instance for the byte type.
static final Equal<Character>	Equal.charEqual	An equal instance for the char type.
static final Equal<Double>	Equal.doubleEqual	An equal instance for the double type.
static final Equal<LazyString>	Equal.eq	An equal instance for lazy strings.
static final Equal<Float>	Equal.floatEqual	An equal instance for the float type.
static final Equal<HList.HNil>	Equal.hListEqual	An equal instance for the empty heterogeneous list.
static final Equal<Integer>	Equal.intEqual	An equal instance for the int type.
static final Equal<Long>	Equal.longEqual	An equal instance for the long type.
static final Equal<Natural>	Equal.naturalEqual	An equal instance for the Natural type.
static final Equal<Short>	Equal.shortEqual	An equal instance for the short type.
static final Equal<StringBuffer>	Equal.stringBufferEqual	An equal instance for the StringBuffer type.
static final Equal<StringBuilder>	Equal.stringBuilderEqual	An equal instance for the StringBuilder type.
static final Equal<String>	Equal.stringEqual	An equal instance for the String type.

Methods in fj that return Equal

Modifier and Type	Method	Description
static <A> Equal<A>	Equal.anyEqual()	Returns an equal instance that uses the Object.equals(Object) method to test for equality.
static <A> Equal<Array<A>>	Equal.arrayEqual(Equal<A> ea)	An equal instance for the Array type.
static <A,B> Equal<A>	Equal.contramap(F<A,B> f, Equal<B> eq)	Static version of Equal.contramap(F)
<B> Equal<B>	Equal.contramap(F<B,A> f)	Maps the given function across this equal as a contra-variant functor.
static <A,B,C> Equal<Either3<A,B,C>>	Equal.either3Equal(Equal<A> ea, Equal<B> eb, Equal<C> ec)
static <A,B> Equal<Either<A,B>>	Equal.eitherEqual(Equal<A> ea, Equal<B> eb)	An equal instance for the Either type.
default Equal<A>	Equal.Definition.equal()	Build an equal instance from this definition.
static <A> Equal<A>	Equal.equal(F<A, F<A,Boolean>> f)	Constructs an equal instance from the given function.
static <A> Equal<A>	Equal.equal(F2<A,A,Boolean> f)	Constructs an equal instance from the given function.
Equal<A>	Ord.equal()	Returns an Equal for this order.
static <A> Equal<A>	Equal.equalDef(Equal.AltDefinition<A> definition)	Constructs an equal instance from the given (alternative) definition.
static <A> Equal<A>	Equal.equalDef(Equal.Definition<A> definition)	Constructs an equal instance from the given definition.
static <E, L extends HList<L>> Equal<HList.HCons<E,L>>	Equal.hListEqual(Equal<E> e, Equal<L> l)	An equal instance for heterogeneous lists.
static <A> Equal<List<A>>	Equal.listEqual(Equal<A> ea)	An equal instance for the List type.
static <A> Equal<NonEmptyList<A>>	Equal.nonEmptyListEqual(Equal<A> ea)	An equal instance for the NonEmptyList type.
final Equal<A>	Equal.not()	An equal instance, which reverts equality for self
static <A> Equal<Option<A>>	Equal.optionEqual(Equal<A> ea)	An equal instance for the Option type.
static <A> Equal<P1<A>>	Equal.p1Equal(Equal<A> ea)	An equal instance for a product-1.
static <A,B> Equal<P2<A,B>>	Equal.p2Equal(Equal<A> ea, Equal<B> eb)	An equal instance for a product-2.
static <A,B,C> Equal<P3<A,B,C>>	Equal.p3Equal(Equal<A> ea, Equal<B> eb, Equal<C> ec)	An equal instance for a product-3.
static <A,B,C,D> Equal<P4<A,B,C,D>>	Equal.p4Equal(Equal<A> ea, Equal<B> eb, Equal<C> ec, Equal<D> ed)	An equal instance for a product-4.
static <A,B,C,D,E> Equal<P5<A,B,C,D,E>>	Equal.p5Equal(Equal<A> ea, Equal<B> eb, Equal<C> ec, Equal<D> ed, Equal<E> ee)	An equal instance for a product-5.
static <A,B,C,D,E,F$> Equal<P6<A,B,C,D,E,F$>>	Equal.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.
static <A,B,C,D,E,F$,G> Equal<P7<A,B,C,D,E,F$,G>>	Equal.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.
static <A,B,C,D,E,F$,G,H> Equal<P8<A,B,C,D,E,F$,G,H>>	Equal.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.
static <I,A> Equal<Result<I,A>>	Equal.resultEqual(Equal<A> ea, Equal<I> ei)
static <A> Equal<Seq<A>>	Equal.seqEqual(Equal<A> e)
static <A> Equal<Set<A>>	Equal.setEqual(Equal<A> e)	Equal instance for sets.
static <A> Equal<Stream<A>>	Equal.streamEqual(Equal<A> ea)	An equal instance for the Stream type.
static <A> Equal<Tree<A>>	Equal.treeEqual(Equal<A> ea)	An equal instance for the Tree type.
static <K,V> Equal<TreeMap<K,V>>	Equal.treeMapEqual(Equal<K> k, Equal<V> v)
static <A> Equal<TreeZipper<A>>	Equal.treeZipperEqual(Equal<A> ea)	An equal instance for the TreeZipper type.
static <A> Equal<V2<A>>	Equal.v2Equal(Equal<A> ea)	An equal instance for a vector-2.
static <A> Equal<V3<A>>	Equal.v3Equal(Equal<A> ea)	An equal instance for a vector-3.
static <A> Equal<V4<A>>	Equal.v4Equal(Equal<A> ea)	An equal instance for a vector-4.
static <A> Equal<V5<A>>	Equal.v5Equal(Equal<A> ea)	An equal instance for a vector-5.
static <A> Equal<V6<A>>	Equal.v6Equal(Equal<A> ea)	An equal instance for a vector-6.
static <A> Equal<V7<A>>	Equal.v7Equal(Equal<A> ea)	An equal instance for a vector-7.
static <A> Equal<V8<A>>	Equal.v8Equal(Equal<A> ea)	An equal instance for a vector-8.
static <A,B> Equal<Validation<A,B>>	Equal.validationEqual(Equal<A> ea, Equal<B> eb)	An equal instance for the Validation type.
static <A,B> Equal<Writer<A,B>>	Equal.writerEqual(Equal<A> eq1, Equal<B> eq2)
static <A> Equal<Zipper<A>>	Equal.zipperEqual(Equal<A> ea)	An equal instance for the Zipper type.

Methods in fj that return types with arguments of type Equal

Modifier and Type	Method	Description
default F<Equal<B>,Equal<A>>	F.contramapEqual()	Promotes this function to map over an Equal as a contravariant functor.
default F<Equal<B>,Equal<A>>	F.contramapEqual()	Promotes this function to map over an Equal as a contravariant functor.

Methods in fj with parameters of type Equal

Modifier and Type	Method	Description
static <A> Equal<Array<A>>	Equal.arrayEqual(Equal<A> ea)	An equal instance for the Array type.
static <A,B> Equal<A>	Equal.contramap(F<A,B> f, Equal<B> eq)	Static version of Equal.contramap(F)
static <A,B,C> Equal<Either3<A,B,C>>	Equal.either3Equal(Equal<A> ea, Equal<B> eb, Equal<C> ec)
static <A,B> Equal<Either<A,B>>	Equal.eitherEqual(Equal<A> ea, Equal<B> eb)	An equal instance for the Either type.
static <A> boolean	Equal.equals0(Class<? super A> clazz, A self, Object other, Equal<A> equal)	Helper method to implement Object.equals(Object) correctly.
static <E, L extends HList<L>> Equal<HList.HCons<E,L>>	Equal.hListEqual(Equal<E> e, Equal<L> l)	An equal instance for heterogeneous lists.
static <A> Equal<List<A>>	Equal.listEqual(Equal<A> ea)	An equal instance for the List type.
static <A> Equal<NonEmptyList<A>>	Equal.nonEmptyListEqual(Equal<A> ea)	An equal instance for the NonEmptyList type.
static <A,B> Equal.Definition<A>	Equal.on(F<A,B> f, Equal<B> eq)	Begin definition of an equal instance.
static <A> Equal<Option<A>>	Equal.optionEqual(Equal<A> ea)	An equal instance for the Option type.
static <A> Equal<P1<A>>	Equal.p1Equal(Equal<A> ea)	An equal instance for a product-1.
static <A,B> Equal<P2<A,B>>	Equal.p2Equal(Equal<A> ea, Equal<B> eb)	An equal instance for a product-2.
static <A,B,C> Equal<P3<A,B,C>>	Equal.p3Equal(Equal<A> ea, Equal<B> eb, Equal<C> ec)	An equal instance for a product-3.
static <A,B,C,D> Equal<P4<A,B,C,D>>	Equal.p4Equal(Equal<A> ea, Equal<B> eb, Equal<C> ec, Equal<D> ed)	An equal instance for a product-4.
static <A,B,C,D,E> Equal<P5<A,B,C,D,E>>	Equal.p5Equal(Equal<A> ea, Equal<B> eb, Equal<C> ec, Equal<D> ed, Equal<E> ee)	An equal instance for a product-5.
static <A,B,C,D,E,F$> Equal<P6<A,B,C,D,E,F$>>	Equal.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.
static <A,B,C,D,E,F$,G> Equal<P7<A,B,C,D,E,F$,G>>	Equal.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.
static <A,B,C,D,E,F$,G,H> Equal<P8<A,B,C,D,E,F$,G,H>>	Equal.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.
static <I,A> Equal<Result<I,A>>	Equal.resultEqual(Equal<A> ea, Equal<I> ei)
static <A> Equal<Seq<A>>	Equal.seqEqual(Equal<A> e)
static <A> Equal<Set<A>>	Equal.setEqual(Equal<A> e)	Equal instance for sets.
static <A> Equal<Stream<A>>	Equal.streamEqual(Equal<A> ea)	An equal instance for the Stream type.
default <B> Equal.Definition<A>	Equal.Definition.then(F<A,B> f, Equal<B> eq)	Refine this equal definition, to tests equality of self and the mapped object in "and" manner.
static <A> Equal<Tree<A>>	Equal.treeEqual(Equal<A> ea)	An equal instance for the Tree type.
static <K,V> Equal<TreeMap<K,V>>	Equal.treeMapEqual(Equal<K> k, Equal<V> v)
static <A> Equal<TreeZipper<A>>	Equal.treeZipperEqual(Equal<A> ea)	An equal instance for the TreeZipper type.
static <A> Equal<V2<A>>	Equal.v2Equal(Equal<A> ea)	An equal instance for a vector-2.
static <A> Equal<V3<A>>	Equal.v3Equal(Equal<A> ea)	An equal instance for a vector-3.
static <A> Equal<V4<A>>	Equal.v4Equal(Equal<A> ea)	An equal instance for a vector-4.
static <A> Equal<V5<A>>	Equal.v5Equal(Equal<A> ea)	An equal instance for a vector-5.
static <A> Equal<V6<A>>	Equal.v6Equal(Equal<A> ea)	An equal instance for a vector-6.
static <A> Equal<V7<A>>	Equal.v7Equal(Equal<A> ea)	An equal instance for a vector-7.
static <A> Equal<V8<A>>	Equal.v8Equal(Equal<A> ea)	An equal instance for a vector-8.
static <A,B> Equal<Validation<A,B>>	Equal.validationEqual(Equal<A> ea, Equal<B> eb)	An equal instance for the Validation type.
static <A,B> Equal<Writer<A,B>>	Equal.writerEqual(Equal<A> eq1, Equal<B> eq2)
static <A> Equal<Zipper<A>>	Equal.zipperEqual(Equal<A> ea)	An equal instance for the Zipper type.

Method parameters in fj with type arguments of type Equal

Modifier and Type	Method	Description
static <A> boolean	Equal.equals0(Class<? super A> clazz, A self, Object other, F0<Equal<A>> equal)	Helper method to implement Object.equals(Object) correctly.

Uses of Equal in fj.data

Fields in fj.data declared as Equal

Modifier and Type	Field	Description
private final Equal<K>	HashMap.e
private static final Equal<Stream<Character>>	LazyString.eqS
private final Equal<K>	PriorityQueue.equal

Methods in fj.data that return Equal

Modifier and Type	Method	Description
static <A> Equal<TreeZipper<A>>	TreeZipper.eq(Equal<A> e)	An Equal instance for tree zippers.
static <A> Equal<Zipper<A>>	Zipper.eq(Equal<A> e)	An Equal instance for Zippers.

Methods in fj.data with parameters of type Equal

Modifier and Type	Method	Description
final boolean	List.allEqual(Equal<A> eq)	Returns whether or not all elements in the list are equal according to the given equality test.
static <K,V> HashMap<K,V>	HashMap.arrayHashMap(Equal<K> equal, Hash<K> hash, P2<K,V>... entries)	Converts the array to a HashMap
static <A> HashSet<A>	HashSet.arrayHashSet(Equal<A> e, Hash<A> h, A... as)	Create a HashSet from the array.
final List<A>	List.delete(A a, Equal<A> e)	Removes the first element that equals the given object.
final Option<Integer>	List.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.
static <A> HashSet<A>	HashSet.empty(Equal<A> e, Hash<A> h)	Creates a new HashSet using the given Equal and Hash
static <K,A> PriorityQueue<K,A>	PriorityQueue.empty(Monoid<K> m, Equal<K> e)	Creates an empty priority queue.
static <A> Equal<TreeZipper<A>>	TreeZipper.eq(Equal<A> e)	An Equal instance for tree zippers.
static <A> Equal<Zipper<A>>	Zipper.eq(Equal<A> e)	An Equal instance for Zippers.
static <K,V> HashMap<K,V>	HashMap.fromMap(Equal<K> eq, Hash<K> h, Map<K,V> map)
final List<List<A>>	List.group(Equal<A> e)	Groups elements according to the given equality implementation by longest sequence of equal elements.
static <K,V> HashMap<K,V>	HashMap.hashMap(Equal<K> e, Hash<K> h)	Construct a hash map.
static <A> HashSet<A>	HashSet.hashSet(Equal<A> e, Hash<A> h, A... as)	Create a HashSet from the array.
final boolean	List.isPrefixOf(Equal<A> eq, List<A> xs)
final boolean	List.isSuffixOf(Equal<A> eq, List<A> xs)
static <K,V> HashMap<K,V>	HashMap.iterableHashMap(Equal<K> equal, Hash<K> hash, Iterable<P2<K,V>> entries)	Converts the Iterable to a HashMap
static <A> HashSet<A>	HashSet.iterableHashSet(Equal<A> e, Hash<A> h, Iterable<A> it)	Create a HashSet from the Iterable.
static <K,V> HashMap<K,V>	HashMap.iteratorHashMap(Equal<K> equal, Hash<K> hash, Iterator<P2<K,V>> entries)	Converts the Iterator to a HashMap
static <A> HashSet<A>	HashSet.iteratorHashSet(Equal<A> e, Hash<A> h, Iterator<A> it)	Create a HashSet from the Iterator.
static <A,B> F2<List<P2<A,B>>, A, Option<B>>	List.lookup(Equal<A> e)	Returns a partially applied version of List.lookup(Equal, List, Object).
static <A,B> Option<B>	List.lookup(Equal<A> e, List<P2<A,B>> x, A a)	Returns an associated value with the given key in the list of pairs.
<A,B> HashMap<A,B>	HashMap.map(F<P2<K,V>,P2<A,B>> function, Equal<A> equal, Hash<A> hash)
<A,B> HashMap<A,B>	HashMap.map(F<K,A> keyFunction, F<V,B> valueFunction, Equal<A> equal, Hash<A> hash)
<A> HashMap<A,V>	HashMap.mapKeys(F<K,A> keyFunction, Equal<A> equal, Hash<A> hash)
final List<A>	List.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.
final Stream<A>	Stream.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.
final List<A>	List.nub(Equal<A> eq)	Removes duplicates according to the given equality.
static <K,A> PriorityQueue<K,A>	PriorityQueue.priorityQueue(Equal<K> e, FingerTree<K,P2<K,A>> ft)	Creates a priority queue from a finger tree.

Constructors in fj.data with parameters of type Equal

Modifier	Constructor	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(Map<K,V> map, Equal<K> e, Hash<K> h)
	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.
private	PriorityQueue(Equal<K> e, FingerTree<K,P2<K,A>> ft)

Uses of Equal in fj.data.hamt

Fields in fj.data.hamt declared as Equal

Modifier and Type	Field	Description
private final Equal<K>	HashArrayMappedTrie.equal

Methods in fj.data.hamt with parameters of type Equal

Modifier and Type	Method	Description
static <K,V> HashArrayMappedTrie<K,V>	HashArrayMappedTrie.empty(Equal<K> e, Hash<K> h)	Creates an empty trie.
private static <K,V> HashArrayMappedTrie<K,V>	HashArrayMappedTrie.hamt(BitSet bs, Seq<Node<K,V>> s, Equal<K> e, Hash<K> h)	Static constructor for a HAMT instance.

Constructors in fj.data.hamt with parameters of type Equal

Modifier	Constructor	Description
private	HashArrayMappedTrie(BitSet bs, Seq<Node<K,V>> s, Equal<K> e, Hash<K> h)	Creates an empty trie for the bitset, sequence of nodes, equal and hash.

Uses of Equal in fj.function

Methods in fj.function with parameters of type Equal

Modifier and Type	Method	Description
static <A,B> F<B,F<A,B>>	Visitor.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>>	Visitor.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.