Modifier and Type | Class and Description |
---|---|
class |
Tuple2<_1,_2>
A 2-element tuple product type, implemented as a specialized HList.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Effect<A>
A function returning "no result", and therefore only useful as a side-effect.
|
interface |
Fn0<A>
|
interface |
Fn1<A,B>
A function taking a single argument.
|
interface |
Fn2<A,B,C>
A function taking two arguments.
|
interface |
Fn3<A,B,C,D>
A function taking three arguments.
|
interface |
Fn4<A,B,C,D,E>
A function taking four arguments.
|
interface |
Fn5<A,B,C,D,E,F>
A function taking five arguments.
|
interface |
Fn6<A,B,C,D,E,F,G>
A function taking six arguments.
|
interface |
Fn7<A,B,C,D,E,F,G,H>
A function taking six arguments.
|
interface |
Fn8<A,B,C,D,E,F,G,H,I>
A function taking six arguments.
|
Modifier and Type | Class and Description |
---|---|
class |
CatMaybes<A>
|
class |
Coalesce<L,R>
|
class |
Constantly<A,B>
A function that takes two arguments and always returns the first argument.
|
class |
Cycle<A>
Given an
Iterable , return an infinite Iterable that repeatedly cycles its elements, in
order. |
class |
Distinct<A>
|
class |
Downcast<A extends B,B>
Covariantly cast a value of type
B to a value of subtype A . |
class |
Empty<A>
A predicate that returns true if
as is empty; false otherwise. |
class |
Flatten<A>
|
class |
Force<A>
Deprecated.
in favor of
traversing into an IO and running it |
class |
Head<A>
|
class |
Id<A>
The identity function.
|
class |
Init<A>
|
class |
Inits<A>
|
class |
Last<A>
|
class |
Magnetize<A>
|
class |
Not<A>
Negate a predicate function.
|
class |
Occurrences<A>
|
class |
Repeat<A>
Given a value, return an infinite
Iterable that repeatedly iterates that value. |
class |
Reverse<A>
Given an
Iterable , return a reversed representation of that Iterable . |
class |
Size |
class |
Sort<A extends Comparable<A>>
|
class |
Tail<A>
Returns the tail of an
Iterable ; the is, an Iterable of all the elements except for the
head element. |
class |
Tails<A>
|
class |
Uncons<A>
|
class |
Upcast<A extends B,B>
Upcast a value of type
B to a value of type A that B extends. |
Modifier and Type | Class and Description |
---|---|
class |
All<A>
Eagerly apply a predicate to each element in an
Iterable , returning true if every element
satisfies the predicate, and false otherwise. |
class |
Alter<A>
|
class |
Any<A>
Eagerly apply a predicate to each element in an
Iterable , returning true if any element
satisfies the predicate, and false otherwise. |
class |
AutoBracket<A extends AutoCloseable,B>
Given an
IO yielding some AutoCloseable type A and a kleisli arrow from that type to a
new IO of type B , attempt to provision the A , applying the body operation if
provisioning was successful and ensuring that AutoCloseable.close() is called regardless of whether the body
succeeds or fails. |
class |
Both<A,B,C>
|
class |
CartesianProduct<A,B>
Lazily compute the cartesian product of an
Iterable<A> and Iterable<B> ,
returning an Iterable<Tuple2<A, B>> , the products as tuples of
multiplicand A s and multiplier B s. |
class |
CmpEq<A extends Comparable<A>>
Given two
Comparable values of type A , return true if the first value is strictly
equal to the second value (according to Comparable.compareTo(Object) ; otherwise, return false. |
class |
Cons<A>
Prepend an element to an
Iterable . |
class |
Difference<A>
|
class |
Drop<A>
Lazily skip the first
n elements from an Iterable by returning an Iterable
that begins iteration after the nth element. |
class |
DropWhile<A>
Lazily limit the
Iterable by skipping the first contiguous group of elements that satisfy the predicate,
beginning iteration at the first element for which the predicate evaluates to false . |
class |
Eq<A>
Type-safe equality in function form; uses
Object.equals(java.lang.Object) , not == . |
class |
Filter<A>
Lazily apply a predicate to each element in an
Iterable , returning an Iterable of just the
elements for which the predicate evaluated to true . |
class |
Find<A>
Iterate the elements in an
Iterable , applying a predicate to each one, returning the first element that
matches the predicate, wrapped in a Maybe . |
class |
GroupBy<K,V>
Given an
Iterable<V> vs and a key function V -> K f ,
fold vs into a Map<K, List<V>> by applying f to each element of
vs , retaining values that map to the same key in a list, in the order they were iterated in. |
class |
GT<A extends Comparable<A>>
Given two
Comparable values of type A , return true if the second value is strictly
greater than the first value; otherwise, return false. |
class |
GTE<A extends Comparable<A>>
Given two
Comparable values of type A , return true if the second value is greater
than or equal to the first value according to Comparable.compareTo(Object) ; otherwise, return false. |
class |
InGroupsOf<A>
Lazily group the
Iterable by returning an Iterable of smaller Iterable s of
size k . |
class |
Intersperse<A>
Lazily inject the provided separator value between each value in the supplied
Iterable . |
class |
Into<A,B,C>
Given an
and a , destructure the
entry and apply the key and value as arguments to the function, returning the result. |
class |
Into1<A,B>
Given an
and a , pop the head and
apply it to the function, returning the result. |
class |
Into3<A,B,C,D>
|
class |
Into4<A,B,C,D,E>
|
class |
Into5<A,B,C,D,E,F>
|
class |
Into6<A,B,C,D,E,F,G>
|
class |
Into7<A,B,C,D,E,F,G,H>
|
class |
Into8<A,B,C,D,E,F,G,H,I>
|
class |
Iterate<A>
|
class |
LazyRec<A,B>
|
class |
LT<A extends Comparable<A>>
Given two
Comparable values of type A , return true if the second value is strictly
less than the first value; otherwise, return false. |
class |
LTE<A extends Comparable<A>>
Given two
Comparable values of type A , return true if the second value is less than
or equal to the first value according to Comparable.compareTo(Object) otherwise, return false. |
class |
MagnetizeBy<A>
|
class |
Map<A,B>
Lazily apply a function to each element in an
Iterable , producing an Iterable of the mapped
results. |
class |
Partition<A,B,C>
Given an
Iterable<A> as and a disjoint mapping function a ->
CoProduct2<A, B> , return a Tuple2 over the lazily unwrapped left A and right
B values in the first and second slots, respectively. |
class |
Peek<A,FA extends Functor<A,?>>
|
class |
Peek2<A,B,FAB extends BoundedBifunctor<A,B,? super A,? super B,?>>
Deprecated.
in favor of producing an
IO from the given BoundedBifunctor and explicitly running it |
class |
PrependAll<A>
Lazily prepend each value with of the
Iterable with the supplied separator value. |
class |
ReduceLeft<A>
|
class |
ReduceRight<A>
|
class |
Replicate<A>
Produce an
Iterable of a value n times. |
class |
Sequence<A,App extends Applicative<?,App>,Trav extends Traversable<?,Trav>,TravA extends Traversable<A,Trav>,AppTrav extends Applicative<TravA,App>>
Given a
Traversable of Applicative s and a pure Applicative constructor, traverse the
elements from left to right, zipping the Applicative s together and collecting the results. |
class |
Slide<A>
|
class |
Snoc<A>
|
class |
SortBy<A,B extends Comparable<B>>
Given an
Iterable and some mapping function from the Iterable element type to some
Comparable type, produce a sorted List of the original elements based on sorting applied to the
result of the mapping function. |
class |
SortWith<A>
Given an
Iterable and a Comparator over the Iterable element type, produce a
sorted List of the original elements based on sorting applied by the Comparator . |
class |
Span<A>
|
class |
Take<A>
Lazily limit the
Iterable to n elements by returning an Iterable that stops
iteration after the nth element, or the last element of the Iterable , whichever comes
first. |
class |
TakeWhile<A>
Lazily limit the
Iterable to the first group of contiguous elements that satisfy the predicate by
iterating up to, but not including, the first element for which the predicate evaluates to false . |
class |
ToArray<A>
Write all the elements of an
Iterable directly into an array of the specified type. |
class |
ToCollection<A,C extends Collection<A>>
Given an
Fn0 of some Collection C , create an instance of C and add all of
the elements in the provided Iterable to the instance. |
class |
ToMap<K,V,M extends Map<K,V>>
|
class |
Tupler2<A,B>
Creates a
Tuple2 from two values. |
class |
Unfoldr<A,B>
|
class |
Until<A>
Given a
predicate function for a value of some type A and an IO that yields a value
of type A , produce an IO that repeatedly executes the original IO until the predicate
returns true when applied to the yielded value. |
class |
Zip<A,B>
Zip together two
Iterable s into a single Iterable of Tuple2<A, B> . |
Modifier and Type | Class and Description |
---|---|
class |
Between<A extends Comparable<A>>
Given two bounds and a value, return whether or not the value is greater than or equal to the lower bound and less
than or equal to the upper bound.
|
class |
Bracket<A,B>
Given an
IO that yields some type A , a cleanup operation to run if a value of that type could be
provisioned, and a kleisli arrow from that type to a new IO of type B , produce an
that, when run, will provision the A ,
flatMap it to B , and clean up the original value if it was produced in the
first place. |
class |
Clamp<A extends Comparable<A>>
Given two bounds and a value, "clamp" the value between the bounds via the following algorithm:
- if the value is strictly less than the lower bound, return the lower bound
- if the value is strictly greater than the upper bound, return the upper bound
- otherwise, return the value
|
class |
CmpEqBy<A,B extends Comparable<B>>
Given a mapping function from some type
A to some Comparable type B and two values
of type A , return true if the first value is strictly equal to the second value (according
to Comparable.compareTo(Object) in terms of their mapped B results; otherwise, return false. |
class |
FoldLeft<A,B>
Given an
Iterable of A s, a starting value B , and a
, iteratively accumulate over the Iterable , ultimately returning
a final B value. |
class |
FoldRight<A,B>
|
class |
GTBy<A,B extends Comparable<B>>
Given a mapping function from some type
A to some Comparable type B and two values
of type A , return true if the second value is strictly greater than the first value in
terms of their mapped B results; otherwise, return false. |
class |
GTEBy<A,B extends Comparable<B>>
Given a mapping function from some type
A to some Comparable type B and two values
of type A , return true if the second value is greater than or equal to the first value in
terms of their mapped B results according to Comparable.compareTo(Object) ; otherwise, return
false. |
class |
LiftA2<A,B,C,App extends Applicative<?,App>,AppC extends Applicative<C,App>>
Lift into and apply an
Fn2 to two Applicative values, returning the result inside the same
Applicative context. |
class |
LTBy<A,B extends Comparable<B>>
Given a mapping function from some type
A to some Comparable type B and two values
of type A , return true if the second value is strictly less than the first value in terms
of their mapped B results; otherwise, return false. |
class |
LTEBy<A,B extends Comparable<B>>
Given a mapping function from some type
A to some Comparable type B and two values
of type A , return true if the second value is less than or equal to the first value in
terms of their mapped B results according to Comparable.compareTo(Object) ; otherwise, return
false. |
class |
ScanLeft<A,B>
Given an
Iterable of A s, a starting value B , and a
, iteratively accumulate over the Iterable , collecting each
function application result, finally returning an Iterable of all the results. |
class |
Times<A>
Given some number of times
n to invoke a function A -> A , and given an input
A , iteratively apply the function to the input, and then to the result of the invocation, a total of
n times, returning the result. |
class |
ZipWith<A,B,C>
Zip together two
Iterable s by applying a zipping function to the successive elements of each
Iterable until one of them runs out of elements. |
Modifier and Type | Class and Description |
---|---|
class |
IfThenElse<A,B> |
class |
LiftA3<A,B,C,D,App extends Applicative<?,App>,AppD extends Applicative<D,App>>
Lift into and apply an
Fn3 to three Applicative values, returning the result inside the same
Applicative context. |
class |
RateLimit<A>
|
Modifier and Type | Class and Description |
---|---|
class |
LiftA4<A,B,C,D,E,App extends Applicative<?,App>,AppE extends Applicative<E,App>>
Lift into and apply an
Fn4 to four Applicative values, returning the result inside the same
Applicative context. |
Modifier and Type | Class and Description |
---|---|
class |
LiftA5<A,B,C,D,E,F,App extends Applicative<?,App>,AppF extends Applicative<F,App>>
Lift into and apply an
Fn5 to five Applicative values, returning the result inside the same
Applicative context. |
Modifier and Type | Class and Description |
---|---|
class |
LiftA6<A,B,C,D,E,F,G,App extends Applicative<?,App>,AppG extends Applicative<G,App>>
Lift into and apply an
Fn6 to six Applicative values, returning the result inside the same
Applicative context. |
Modifier and Type | Class and Description |
---|---|
class |
LiftA7<A,B,C,D,E,F,G,H,App extends Applicative<?,App>,AppH extends Applicative<H,App>>
Lift into and apply an
Fn7 to seven Applicative values, returning the result inside the same
Applicative context. |
Modifier and Type | Class and Description |
---|---|
class |
Trampoline<A,B>
Given an
(analogous to "recurse" and "return"
tail position instructions, respectively), produce a that unrolls the original
function by iteratively passing each result that matches the input (A ) back to the original function,
and then terminating on and returning the first output (B ). |
Modifier and Type | Interface and Description |
---|---|
interface |
BiMonoidFactory<A,B,C> |
interface |
BiPredicate<A,B>
|
interface |
BiSemigroupFactory<A,B,C> |
interface |
Kleisli<A,B,M extends Monad<?,M>,MB extends Monad<B,M>>
|
interface |
MonoidFactory<A,B> |
interface |
Predicate<A>
A specialized
Fn1 that returns a Boolean . |
interface |
SemigroupFactory<A,B> |
Modifier and Type | Class and Description |
---|---|
class |
State<S,A>
The state
Monad , useful for iteratively building up state and state-contextualized result. |
class |
Writer<W,A>
The lazy writer monad, a monad capturing some accumulation (eventually to be folded in terms of a given monoid) and
a value.
|
Modifier and Type | Interface and Description |
---|---|
interface |
MonadWriter<W,A,MW extends MonadWriter<W,?,MW>>
A
Monad that is capable of writing and accumulating state alongside a value, but is not necessarily capable
of simultaneously accessing the state and the value. |
Modifier and Type | Method and Description |
---|---|
MonadWriter<W,A,MW> |
MonadWriter.censor(Fn1<? super W,? extends W> fn)
Update the accumulated state.
|
default <B> MonadWriter<W,B,MW> |
MonadWriter.discardL(Applicative<B,MW> appB)
Sequence both this
Applicative and appB , discarding this Applicative's
result and returning appB . |
default <B> MonadWriter<W,A,MW> |
MonadWriter.discardR(Applicative<B,MW> appB)
Sequence both this
Applicative and appB , discarding appB's result and
returning this Applicative . |
<B> MonadWriter<W,B,MW> |
MonadWriter.flatMap(Fn1<? super A,? extends Monad<B,MW>> f)
Chain dependent computations that may continue or short-circuit based on previous results.
|
default <B> MonadWriter<W,B,MW> |
MonadWriter.fmap(Fn1<? super A,? extends B> fn)
Covariantly transmute this functor's parameter using the given mapping function.
|
<B> MonadWriter<W,Tuple2<A,B>,MW> |
MonadWriter.listens(Fn1<? super W,? extends B> fn)
Map the accumulation into a value and pair it with the current output.
|
<B> MonadWriter<W,B,MW> |
MonadWriter.pure(B b)
Lift the value
b into this applicative functor. |
default <B> MonadWriter<W,B,MW> |
MonadWriter.zip(Applicative<Fn1<? super A,? extends B>,MW> appFn)
Given another instance of this applicative over a mapping function, "zip" the two instances together using
whatever application semantics the current applicative supports.
|
Modifier and Type | Method and Description |
---|---|
default <B> Lazy<? extends MonadWriter<W,B,MW>> |
MonadWriter.lazyZip(Lazy<? extends Applicative<Fn1<? super A,? extends B>,MW>> lazyAppFn)
Given a
lazy instance of this applicative over a mapping function, "zip" the two instances together
using whatever application semantics the current applicative supports. |
Modifier and Type | Class and Description |
---|---|
class |
StateT<S,M extends MonadRec<?,M>,A>
The
State monad transformer . |
class |
WriterT<W,M extends MonadRec<?,M>,A>
A
monad transformer for Writer . |
Modifier and Type | Interface and Description |
---|---|
interface |
Monoid<A>
|
Modifier and Type | Class and Description |
---|---|
class |
AddAll<A,C extends Collection<A>>
The
Monoid instance formed under mutative concatenation for an arbitrary Collection . |
class |
And
A
Monoid instance formed by Boolean . |
class |
Collapse<_1,_2>
|
class |
Compose<A>
|
class |
Concat<A>
|
class |
Endo<A>
|
class |
EndoK<M extends MonadRec<?,M>,A,MA extends MonadRec<A,M>>
The monoid formed under monadic endomorphism.
|
class |
First<A>
|
class |
Join
A
Monoid instance formed by String that concats two strings together. |
class |
LeftAll<L,R>
|
class |
LeftAny<L,R>
|
class |
Merge<L,R>
A
Monoid instance formed by Either.merge(com.jnape.palatable.lambda.functions.Fn2<? super L, ? super L, ? extends L>, com.jnape.palatable.lambda.functions.Fn2<? super R, ? super R, ? extends R>, com.jnape.palatable.lambda.adt.Either<L, R>...) , a semigroup over L , and a monoid over
R . |
class |
MergeMaps<K,V>
|
class |
Or
A
Monoid instance formed by Boolean . |
class |
Present<A>
|
class |
PutAll
|
class |
RightAll<L,R>
|
class |
RightAny<L,R>
|
class |
RunAll<A>
|
class |
Trivial
|
class |
Union<A>
|
class |
Xor
Logical exclusive-or.
|
Modifier and Type | Class and Description |
---|---|
class |
Matching<S,T,A,B> |
class |
Over<S,T,A,B>
Given an
Optic , a function from A to B , and a "larger" value S ,
produce a T by retrieving the A from the S , applying the function, and
updating the S with the B resulting from the function. |
class |
Pre<P extends Profunctor<?,?,? extends P>,S,T,A,B>
|
class |
Re<S,T,A,B>
Turn an
Optic with a unary mapping that can be used for setting (e.g. |
class |
Set<S,T,A,B>
|
class |
Under<S,T,A,B>
|
class |
View<S,T,A,B>
|
Modifier and Type | Interface and Description |
---|---|
interface |
Semigroup<A>
A
Semigroup is a closed, associative category. |
Modifier and Type | Class and Description |
---|---|
class |
Absent<A>
|
class |
Intersection<A>
|
class |
Max<A extends Comparable<A>>
A
Semigroup over A that chooses between two values x and y via the
following rules:
If x is strictly less than y , return y
Otherwise, return x
|
class |
MaxBy<A,B extends Comparable<B>>
Given a mapping function from some type
A to some Comparable type B , produce a
Semigroup over A that chooses between two values x and y via the
following rules:
If x is strictly less than y in terms of B , return y
Otherwise, return x
|
class |
Min<A extends Comparable<A>>
A
Semigroup over A that chooses between two values x and y via the
following rules:
If x is strictly greater than y , return y
Otherwise, return x
|
class |
MinBy<A,B extends Comparable<B>>
Given a mapping function from some type
A to some Comparable type B , produce a
Semigroup over A that chooses between two values x and y via the
following rules:
If x is strictly greater than y in terms of B , return y
Otherwise, return x
|