Docs For Class Float

Description

A simple Float data type.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: Float.class.php,v 1.6 2007/09/04 20:25:28 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/Primitives/Numbers/Float.class.php (line 25)

SObject
   |
   --Magnitude
      |
      --Number
         |
         --Float

Direct descendents

Class	Description
Double	A simple Float data type.

Method Summary

object Number dividedBy (object Number $aNumber)

object Double fromString (string $string, [mixed $class = 'Float'])

object Number multipliedBy (object Number $aNumber)

object Number plus (object Number $aNumber)

object Float withValue (mixed $value, [optional $class = 'Float'])

object Float zero ([optional $class = 'Float'])

void _setValue (mixed $value)

Methods

dividedBy (line 113)

Answer the result of dividing the receiver and aNumber.

since: 7/14/05
access: public

object Number dividedBy (object Number $aNumber)

object Number $aNumber

Redefinition of:

Number::dividedBy(): Answer the result of dividing the receiver and aNumber.

fromString (line 55)

Answer a new object with the value specified

since: 3/14/06
access: public

object Double fromString (string $string, [mixed $class = 'Float'])

string $string: a string representation of the object

Redefinition of:

Number::fromString(): Answer a new object with the value specified

Redefined in descendants as:

Double::fromString() : Answer a new object with the value specified

multipliedBy (line 99)

Answer the result of multiplying the receiver and aNumber.

since: 7/14/05
access: public

object Number multipliedBy (object Number $aNumber)

object Number $aNumber

Redefinition of:

Number::multipliedBy(): Answer the result of multiplying the receiver and aNumber.

plus (line 85)

Answer the sum of the receiver and aNumber.

since: 7/14/05
access: public

object Number plus (object Number $aNumber)

object Number $aNumber

Redefinition of:

Number::plus(): Answer the sum of the receiver and aNumber.

withValue (line 43)

Answer a new object with the value specified

since: 7/14/05
access: public

object Float withValue (mixed $value, [optional $class = 'Float'])

mixed $value
optional $class: string $class The class to instantiate. Do NOT use outside of this package.

Redefinition of:

Number::withValue(): Answer a new object with the value specified

Redefined in descendants as:

Double::withValue() : Answer a new object with the value specified

zero (line 69)

Answer a new object with the value zero

since: 7/14/05
access: public

object Float zero ([optional $class = 'Float'])

optional $class: string $class The class to instantiate. Do NOT use outside of this package.

Redefinition of:

Number::zero(): Answer a new object with the value zero

Redefined in descendants as:

Double::zero() : Answer a new object with the value zero

_setValue (line 131)

Set the internal value to a PHP primitive.

since: 7/14/05
access: private

void _setValue (mixed $value)

mixed $value

Redefinition of:

Number::_setValue(): Set the internal value to a PHP primitive.

Redefined in descendants as:

Double::_setValue() : Set the internal value to a PHP primitive.
StorableFloat::_setValue() : Set the value

Inherited Methods

Inherited From Number

Number::abs()
Number::asDouble()
Number::asFloat()
Number::asInteger()
Number::asNumber()
Number::ceiling()
Number::dividedBy()
Number::floor()
Number::fromString()
Number::isEqualTo()
Number::isLessThan()
Number::minus()
Number::modIntegerQuotient()
Number::modulo()
Number::multipliedBy()
Number::negated()
Number::plus()
Number::printableString()
Number::reciprical()
Number::remainder()
Number::remIntegerQuotient()
Number::truncated()
Number::value()
Number::withValue()
Number::zero()
Number::_setValue()

Inherited From Magnitude

Magnitude::isBetween()
Magnitude::isEqualTo()
Magnitude::isGreaterThan()
Magnitude::isGreaterThanOrEqualTo()
Magnitude::isLessThan()
Magnitude::isLessThanOrEqualTo()
Magnitude::max()
Magnitude::min()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()