method

max

Ruby latest stable (v1_8_7_72) - 1 note - Class: Enumerable

max() public

Returns the object in enum with the maximum value. The first form assumes all objects implement Comparable; the second uses the block to return a <=> b.

   a = %w(albatross dog horse)
   a.max                                  #=> "horse"
   a.max {|a,b| a.length <=> b.length }   #=> "albatross"

Show source

/*
 *  call-seq:
 *     enum.max                   => obj
 *     enum.max {|a,b| block }    => obj
 *
 *  Returns the object in _enum_ with the maximum value. The
 *  first form assumes all objects implement <code>Comparable</code>;
 *  the second uses the block to return <em>a <=> b</em>.
 *
 *     a = %w(albatross dog horse)
 *     a.max                                  #=> "horse"
 *     a.max {|a,b| a.length <=> b.length }   #=> "albatross"
 */

static VALUE
enum_max(obj)
    VALUE obj;
{
    VALUE result = Qundef;

    rb_iterate(rb_each, obj, rb_block_given_p() ? max_ii : max_i, (VALUE)&result);
    if (result == Qundef) return Qnil;
    return result;
}

February 16, 2009

2 thanks

Capping values

This method is very useful when you want to cap values:

 # minimum ≤ value
 value = [input.to_i, minimum].max

 # value ≤ maximum
 value = [input.to_i, maximum].min

 # minimum ≤ value ≤ maximum
 value = [ [input.to_i, minimum].max, maximum ].min

 # Practical example: Make sure destination is within container
 destination.x = [ [current.x + current.velocity.x, 0].max, container.width  ].min
 destination.y = [ [current.y + current.velocity.y, 0].max, container.height ].min

max

Related methods

Capping values