GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  NUMBER::UNCERTAINTY (3)

.ds Aq ’

NAME

Number::Uncertainty - An object-orientated uncertainty object

CONTENTS

SYNOPSIS



  $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 );



DESCRIPTION

Stores information about a value and its error bounds.

REVISION

$Id: Uncertainty.pm,v 1.4 2005/10/26 20:13:57 cavanagh Exp $

METHODS

    Constructor

<B>newB> 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.

    Accessor Methods

<B>valueB> Sets or gets the value of the number



   $obj->value( $val );
   $val = $obj->value();



<B>errorB> Sets or gets the value of the error



   $obj->error( $err );
   $err = $obj->error();



<B>lowerB> Sets or gets the value of the lower error value



   $obj->lower( $lower );
   $lower = $obj->lower();



<B>upperB> Sets or gets the value of the upper error value



   $obj->upper( $upper );
   $upper = $obj->upper();



<B>minB> Sets or gets the value of the minimum value



   $obj->lower( $min );
   $min = $obj->min();



<B>maxB> Sets or gets the value of the maximum value



   $obj->max( $max );
   $max = $obj->max();



<B>boundB> Flag to say whether the value() is an upper or lower bound



   $obj->bound( upper );
   $obj->bound( lower );
   $obj->bound( undef );
   $flag = $obj->bound();



    General Methods

<B>configureB> Configures the object, takes an options hash as an argument



  $obj->configure( %options );



Does nothing if the array is not supplied.

    Operator Overloading

These operators are overloaded:
<B>‘‘’’B> When the object is used in a string context it is stringify’ed.
<B>==B> When the object is equated then we do a comparison and find whether the two values are within the error bounds.
<B>!=B> When the object is equated then we do a comparison and find whether the two values are within the error bounds.
<B>greater_thanB>
<B>less_thanB>
<B>*B> When the object is multiplied.

COPYRIGHT

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.

AUTHORS

Alasdair Allan <aa@astro.ex.ac.uk>,
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 UNCERTAINTY (3) 2005-10-26

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.