Class MaxBy<A, B extends Comparable<B>>

java.lang.Object

com.jnape.palatable.lambda.semigroup.builtin.MaxBy<A,B>

Type Parameters:

A - the value type

B - the mapped comparison type

All Implemented Interfaces:

Fn1<Fn1<? super A, ? extends B>, Fn1<A,Fn1<A,A>>>, Fn2<Fn1<? super A, ? extends B>, A, Fn1<A,A>>, Fn3<Fn1<? super A, ? extends B>, A, A, A>, SemigroupFactory<Fn1<? super A, ? extends B>, A>, Applicative<Fn1<A,Fn1<A,A>>, Fn1<Fn1<? super A, ? extends B>, ?>>, Cartesian<Fn1<? super A, ? extends B>, Fn1<A,Fn1<A,A>>, Fn1<?,?>>, Cocartesian<Fn1<? super A, ? extends B>, Fn1<A,Fn1<A,A>>, Fn1<?,?>>, Contravariant<Fn1<? super A, ? extends B>, Profunctor<?, Fn1<A,Fn1<A,A>>, Fn1<?,?>>>, Functor<Fn1<A,Fn1<A,A>>, Fn1<Fn1<? super A, ? extends B>, ?>>, Profunctor<Fn1<? super A, ? extends B>, Fn1<A,Fn1<A,A>>, Fn1<?,?>>, Monad<Fn1<A,Fn1<A,A>>, Fn1<Fn1<? super A, ? extends B>, ?>>, MonadReader<Fn1<? super A, ? extends B>, Fn1<A,Fn1<A,A>>, Fn1<Fn1<? super A, ? extends B>, ?>>, MonadRec<Fn1<A,Fn1<A,A>>, Fn1<Fn1<? super A, ? extends B>, ?>>, MonadWriter<Fn1<? super A, ? extends B>, Fn1<A,Fn1<A,A>>, Fn1<Fn1<? super A, ? extends B>, ?>>

public final class MaxBy<A, B extends Comparable<B>>
extends Object
implements SemigroupFactory<Fn1<? super A, ? extends B>, A>

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

See Also:

• Max
• MaxWith
• MinBy

Field Summary

Fields

Modifier and Type	Field	Description
private static final MaxBy<?,?>	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MaxBy()

Method Summary

Modifier and Type	Method	Description
Semigroup<A>	checkedApply(Fn1<? super A, ? extends B> compareFn)	Invoke this function with the given argument, potentially throwing any Throwable.
static <A, B extends Comparable<B>> MaxBy<A,B>	maxBy()
static <A, B extends Comparable<B>> Semigroup<A>	maxBy(Fn1<? super A, ? extends B> compareFn)
static <A, B extends Comparable<B>> Fn1<A,A>	maxBy(Fn1<? super A, ? extends B> compareFn, A x)
static <A, B extends Comparable<B>> A	maxBy(Fn1<? super A, ? extends B> compareFn, A x, A y)

Methods inherited from class Object

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

Methods inherited from interface 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 Fn2

toBiFunction

Methods inherited from interface Fn3

apply, apply, checkedApply, compose, contraMap, diMapL, discardR, flip, uncurry, widen

Methods inherited from interface Functor

coerce

Methods inherited from interface SemigroupFactory

apply, checkedApply

Field Details

INSTANCE

private static final MaxBy<?,?> INSTANCE

Constructor Details

MaxBy

private MaxBy()

Method Details

checkedApply

public Semigroup<A> checkedApply(Fn1<? super A, ? extends B> compareFn)

Description copied from interface: Fn2

Invoke this function with the given argument, potentially throwing any Throwable.

Specified by:

checkedApply in interface Fn1<A, B extends Comparable<B>>

Specified by:

checkedApply in interface Fn2<Fn1<? super A, ? extends B extends Comparable<B>>, A, Fn1<A,A>>

Specified by:

checkedApply in interface SemigroupFactory<A, B extends Comparable<B>>

Parameters:

compareFn - the argument

Returns:

the result of the function application

maxBy

public static <A, B extends Comparable<B>>
MaxBy<A,B> maxBy()

maxBy

public static <A, B extends Comparable<B>>
Semigroup<A> maxBy(Fn1<? super A, ? extends B> compareFn)

maxBy

public static <A, B extends Comparable<B>> Fn1<A,A> maxBy(Fn1<? super A, ? extends B> compareFn,
 A x)

maxBy

public static <A, B extends Comparable<B>> A maxBy(Fn1<? super A, ? extends B> compareFn,
 A x,
 A y)