NAME

Chart::Clicker::Data::Range

DESCRIPTION

Chart::Clicker::Data::Range implements a range of values.

SYNOPSIS

  use Chart::Clicker::Data::Range;

  my $range = Chart::Clicker::Data::Range->new({
    lower => 1,
    upper => 10
  });

ATTRIBUTES

lower

Set/Get the lower bound for this Range

max

Set/Get the maximum value allowed for this Range. This value should only be set if you want to EXPLICITLY set the upper value.

min

Set/Get the minimum value allowed for this Range. This value should only be set if you want to EXPLICITLY set the lower value.

upper

Set/Get the upper bound for this Range

METHODS

new

Creates a new, empty Series

add

Adds the specified range to this one. The lower is reduced to that of the provided one if it is lower, and the upper is ADDED to this range's upper.

combine

Combine this range with the specified so that this range encompasses the values specified. For example, adding a range with an upper-lower of 1-10 with one of 5-20 will result in a combined range of 1-20.

contains ($value)

Returns true if supplied value falls within this range (inclusive). Otherwise returns false.

divvy

  my $values = $range->divvy(5);

Returns an arrayref of $N - 1 values equally spaced in the range so that it may be divided into $N pieces.

span

Returns the span of this range, or UPPER - LOWER.

AUTHOR

Cory G Watson <gphat@cpan.org>

LICENSE

You can redistribute and/or modify this code under the same terms as Perl itself.

cpanm Chart::Clicker

perl -MCPAN -e shell
install Chart::Clicker