diff options
Diffstat (limited to 'lib/Data/MultiValued/Ranges.pm')
| -rw-r--r-- | lib/Data/MultiValued/Ranges.pm | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/lib/Data/MultiValued/Ranges.pm b/lib/Data/MultiValued/Ranges.pm index 7193df6..3da1594 100644 --- a/lib/Data/MultiValued/Ranges.pm +++ b/lib/Data/MultiValued/Ranges.pm @@ -41,7 +41,8 @@ sub _build__storage { $obj->set({ from => $min, to => $max, value => $the_value }); Stores the given value for the given range. Throws -L<Data::MultiValued::Exceptions::BadRange> if C<< $min > $max >>. +L<Data::MultiValued::Exceptions::BadRange|Data::MultiValued::Exceptions/Data::MultiValued::Exceptions::BadRange> +if C<< $min > $max >>. The range is defined as C<< Num $x : $min <= $x < $max >>. A C<< from => undef >> means "from -Inf", and a C<< to => undef >> means "to @@ -87,9 +88,9 @@ sub set { my $value = $obj->get({ at => $point }); Retrieves the value for the given point. Throws a -L<Data::MultiValued::Exceptions::RangeNotFound> exception if no ranges -exist in this object that include the point (remember that a range -does not include its C<to> point). +L<Data::MultiValued::Exceptions::RangeNotFound|Data::MultiValued::Exceptions/Data::MultiValued::Exceptions::RangeNotFound> +exception if no ranges exist in this object that include the point +(remember that a range does not include its C<to> point). A C<< at => undef >> means "at -Inf". Not passing in C<at> is equivalent to passing C<undef>. @@ -114,7 +115,8 @@ sub get { $obj->clear({ from => $min, to => $max }); Deletes all values for the given range. Throws -L<Data::MultiValued::Exceptions::BadRange> if C<< $min > $max >>. +L<Data::MultiValued::Exceptions::BadRange|Data::MultiValued::Exceptions/Data::MultiValued::Exceptions::BadRange> +if C<< $min > $max >>. A C<< from => undef >> means "from -Inf", and a C<< to => undef >> means "to +Inf". Not passing in C<from> or C<to> is equivalent to |