Max

Max Number

Max is a Monoid that will combines (2) Numbers, resulting in the largest of the two.

import Max from 'crocks/Max'
import mconcat from 'crocks/helpers/mconcat'

Max(76)
//=> Max 76

mconcat(Max, [ 95, 102, 56 ])
//=> Max 102

Max(100)
  .concat(Max(10))
//=> Max 100

Max.empty()
  .concat(Max(100))
//=> Max 100

Construction

Max :: Number -> Max Number

Max is a Monoid fixed to the type of Number and as such requires a Number instance to be passed to the constructor. A new Max instance is returned, wrapping the provided Number.

The values undefined, null and NaN will map to the empty (-Infinity) instead of throwing a TypeError.

import Max from 'crocks/Max'

import equals from 'crocks/pointfree/equals'

Max(99)
//=> Max 99

Max(Infinity)
//=> Max Infinity

Max(null)
//=> Max -Infinity

equals(Max(undefined), Max.empty())
//=> true

Constructor Methods

empty

Max.empty :: () -> Max

empty provides the identity for the Monoid in that when the value it provides is concated to any other value, it will return the other value. In the case of Max the result of empty is -Infinity. empty is available on both the Constructor and the Instance for convenience.

import Max from 'crocks/Max'

Max.empty()
//=> Max -Infinity

Max.empty()
  .concat(Max.empty())
//=> Max -Infinity

Max(32)
  .concat(Max.empty())
//=> Max 32

Max.empty()
  .concat(Max(34))
//=> Max 34

Instance Methods

equals

Max a ~> b -> Boolean

Used to compare the underlying values of (2) Max instances for equality by value, equals takes any given argument and returns true if the passed argument is a Max with an underlying value equal to the underlying value of the Max the method is being called on. If the passed argument is not a Max or the underlying values are not equal, equals will return false.

import Max from 'crocks/Max'

Max(5)
  .equals(Max(5))
//=> true

Max(25)
  .equals(Max(31))
//=> false

concat

Max ~> Max -> Max

concat is used to combine (2) Semigroups of the same type under an operation specified by the Semigroup. In the case of Max, it will result in the largest of the (2) Numbers.

import Max from 'crocks/Max'

Max(23)
  .concat(Max(13))
//=> Max 23

Max(-23)
  .concat(Max(-32))
//=> Max -23

Max.empty()
  .concat(Max(Infinity))
//=> Max Infinity

valueOf

Max ~> () -> Number

valueOf is used on all crocks Monoids as a means of extraction. While the extraction is available, types that implement valueOf are not necessarily a Comonad. This function is used primarily for convenience for some of the helper functions that ship with crocks. Calling valueOf on a Max instance will result in the underlying Number.

import Max from 'crocks/Max'

Max(4)
  .valueOf()
//=> 4

Max.empty()
  .valueOf()
//=> -Infinity

Max(34)
  .concat(Max(21))
  .valueOf()
//=> 34

Contribute on Github! Edit this section.