Class Clamp<A extends java.lang.Comparable<A>>
- java.lang.Object
-
- com.jnape.palatable.lambda.functions.builtin.fn3.Clamp<A>
-
- Type Parameters:
A
- the bounds and input type
- All Implemented Interfaces:
Fn1<A,Fn1<A,Fn1<A,A>>>
,Fn2<A,A,Fn1<A,A>>
,Fn3<A,A,A,A>
,Applicative<Fn1<A,Fn1<A,A>>,Fn1<A,?>>
,Cartesian<A,Fn1<A,Fn1<A,A>>,Fn1<?,?>>
,Cocartesian<A,Fn1<A,Fn1<A,A>>,Fn1<?,?>>
,Contravariant<A,Profunctor<?,Fn1<A,Fn1<A,A>>,Fn1<?,?>>>
,Functor<Fn1<A,Fn1<A,A>>,Fn1<A,?>>
,Profunctor<A,Fn1<A,Fn1<A,A>>,Fn1<?,?>>
,Monad<Fn1<A,Fn1<A,A>>,Fn1<A,?>>
,MonadReader<A,Fn1<A,Fn1<A,A>>,Fn1<A,?>>
,MonadRec<Fn1<A,Fn1<A,A>>,Fn1<A,?>>
,MonadWriter<A,Fn1<A,Fn1<A,A>>,Fn1<A,?>>
public final class Clamp<A extends java.lang.Comparable<A>> extends java.lang.Object implements Fn3<A,A,A,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
-
-
Constructor Summary
Constructors Modifier Constructor Description private
Clamp()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description A
checkedApply(A lower, A upper, A a)
static <A extends java.lang.Comparable<A>>
Clamp<A>clamp()
static <A extends java.lang.Comparable<A>>
Fn2<A,A,A>clamp(A lower)
static <A extends java.lang.Comparable<A>>
Fn1<A,A>clamp(A lower, A upper)
static <A extends java.lang.Comparable<A>>
Aclamp(A lower, A upper, A a)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.jnape.palatable.lambda.functions.Fn1
andThen, carry, cartesian, censor, choose, cocartesian, diMap, diMapR, discardL, flatMap, fmap, lazyZip, listens, local, pure, self, thunk, toFunction, trampolineM, zip, zip
-
Methods inherited from interface com.jnape.palatable.lambda.functions.Fn2
checkedApply, toBiFunction
-
-
-
-
Field Detail
-
INSTANCE
private static final Clamp<?> INSTANCE
-
-
Method Detail
-
clamp
public static <A extends java.lang.Comparable<A>> Clamp<A> clamp()
-
clamp
public static <A extends java.lang.Comparable<A>> Fn2<A,A,A> clamp(A lower)
-
clamp
public static <A extends java.lang.Comparable<A>> Fn1<A,A> clamp(A lower, A upper)
-
clamp
public static <A extends java.lang.Comparable<A>> A clamp(A lower, A upper, A a)
-
-