Number::Uncertainty - An object-orientated uncertainty object
$obj = new Number::Uncertainty ( Value => $value ); $obj = new Number::Uncertainty ( Value => $value, Error => $error_bar ); $obj = new Number::Uncertainty ( Value => $value, Lower => $lower_error_bar, Upper => $upper_error_bar ); $obj = new Number::Uncertainty ( Value => $value, Min => $minimum_value, Max => $maximum_value ); $obj = new Number::Uncertainty ( Value => $value, Bound => 'lower' ); $obj = new Number::Uncertainty ( Value => $value, Bound => 'upper' );
Stores information about a value and its error bounds.
$Id: Uncertainty.pm,v 1.4 2005/10/26 20:13:57 cavanagh Exp $
Create a new instance from a hash of options
$object = new Number::Uncertainty( %hash );
returns a reference a Number::Uncertainty object. 'Value' is the sole mandatory agruement.
Number::Uncertainty
Sets or gets the value of the number
$obj->value( $val ); $val = $obj->value();
Sets or gets the value of the error
$obj->error( $err ); $err = $obj->error();
Sets or gets the value of the lower error value
$obj->lower( $lower ); $lower = $obj->lower();
Sets or gets the value of the upper error value
$obj->upper( $upper ); $upper = $obj->upper();
Sets or gets the value of the minimum value
$obj->lower( $min ); $min = $obj->min();
Sets or gets the value of the maximum value
$obj->max( $max ); $max = $obj->max();
Flag to say whether the value() is an upper or lower bound
$obj->bound( 'upper' ); $obj->bound( 'lower' ); $obj->bound( undef ); $flag = $obj->bound();
Configures the object, takes an options hash as an argument
$obj->configure( %options );
Does nothing if the array is not supplied.
These operators are overloaded:
When the object is used in a string context it is stringify'ed.
When the object is equated then we do a comparison and find whether the two values are within the error bounds.
When the object is multiplied.
Copyright (C) 2005 University of Exeter. All Rights Reserved.
This program was written as part of the eSTAR project and is free software; you can redistribute it and/or modify it under the terms of the GNU Public License.
Alasdair Allan <aa@astro.ex.ac.uk>,
To install Number::Uncertainty, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Number::Uncertainty
CPAN shell
perl -MCPAN -e shell install Number::Uncertainty
For more information on module installation, please visit the detailed CPAN module installation guide.