API for clojure.algo.generic.comparison - Generic versions of common functions 0.1.3 (in development)

by Konrad Hinsen

Full namespace name: clojure.algo.generic.comparison

Overview

Generic comparison interface
This library defines generic versions of = not= < > <= >= zero?
as multimethods that can be defined for any type. Of the
greater/less-than relations, types must minimally implement >.

Public Variables and Functions



<

multimethod
Usage: (< x)
       (< x y)
       (< x y & more)
Return true if each argument is smaller than the following ones.
The minimal implementation for type ::my-type is the binary form
with dispatch value [::my-type ::my-type]. A default implementation
is provided in terms of >.

    
    
    Source
  


<=

multimethod
Usage: (<= x)
       (<= x y)
       (<= x y & more)
Return true if each arguments is smaller than or equal to the following
ones. The minimal implementation for type ::my-type is the binary form
with dispatch value [::my-type ::my-type]. A default implementation
is provided in terms of >.

    
    
    Source
  


=

multimethod
Usage: (= x)
       (= x y)
       (= x y & more)
Return true if all arguments are equal. The minimal implementation for type
::my-type is the binary form with dispatch value [::my-type ::my-type].

    
    
    Source
  


>

multimethod
Usage: (> x)
       (> x y)
       (> x y & more)
Return true if each argument is larger than the following ones.
The minimal implementation for type ::my-type is the binary form
with dispatch value [::my-type ::my-type].

    
    
    Source
  


>=

multimethod
Usage: (>= x)
       (>= x y)
       (>= x y & more)
Return true if each argument is larger than or equal to the following
ones. The minimal implementation for type ::my-type is the binary form
with dispatch value [::my-type ::my-type]. A default implementation
is provided in terms of <.

    
    
    Source
  


max

function
Usage: (max x)
       (max x y)
       (max x y & more)
Returns the greatest of its arguments. Like clojure.core/max except that
is uses generic comparison functions implementable for any data type.

    
    
    Source
  


min

function
Usage: (min x)
       (min x y)
       (min x y & more)
Returns the least of its arguments. Like clojure.core/min except that
is uses generic comparison functions implementable for any data type.

    
    
    Source
  


neg?

multimethod
Usage: (neg? x)
Return true of x is negative.

    
    
    Source
  


not=

function
Usage: (not= & args)
Equivalent to (not (= ...)).

    
    
    Source
  


pos?

multimethod
Usage: (pos? x)
Return true of x is positive.

    
    
    Source
  


zero?

multimethod
Usage: (zero? x)
Return true of x is zero.

    
    
    Source
  
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.