Public Types | Public Member Functions | Protected Attributes

mln::value::float01 Class Reference

Class for floating values restricted to the interval [0..1] and discretized with n bits. More...

#include <float01.hh>

Inheritance diagram for mln::value::float01:
Inheritance graph

List of all members.

Public Types

typedef Floating< void > category
typedef std::pair< unsigned,
unsigned long > 
enc
 Encoding associated type.
typedef float equiv
 Equivalent associated type.
typedef float01 exact_t

Public Member Functions

 float01 ()
 Ctor.
template<unsigned n>
 float01 (const float01_< n > &val)
 Ctor.
 float01 (unsigned nbits, float val)
 Ctor.
unsigned nbits () const
 Access to the encoding size.
 operator float () const
 Conversion to float.
float01set_nbits (unsigned nbits)
 Set the encoding size to nbits.
const float01 to_nbits (unsigned nbits) const
 Return an equivalent gray encoded on nbits bits.
float value () const
 Access to std type.
unsigned long value_ind () const
 Access to the position in the quantized interval.

Protected Attributes

unsigned nbits_
 Encoding size.
unsigned long val_
 Value.

Detailed Description

Class for floating values restricted to the interval [0..1] and discretized with n bits.

Definition at line 56 of file float01.hh.


Member Typedef Documentation

typedef Floating<void> mln::value::Floating< float01 >::category [inherited]

Reimplemented from mln::value::Scalar< float01 >.

Definition at line 64 of file floating.hh.

typedef std::pair<unsigned, unsigned long> mln::value::float01::enc

Encoding associated type.

Definition at line 61 of file float01.hh.

Equivalent associated type.

Definition at line 64 of file float01.hh.

typedef float01 mln::Object< float01 >::exact_t [inherited]

Definition at line 173 of file object.hh.


Constructor & Destructor Documentation

mln::value::float01::float01 (  )  [inline]

Ctor.

Definition at line 151 of file float01.hh.

template<unsigned n>
mln::value::float01::float01 ( const float01_< n > &  val  )  [inline]

Ctor.

Definition at line 158 of file float01.hh.

mln::value::float01::float01 ( unsigned  nbits,
float  val 
) [inline]

Ctor.

Definition at line 165 of file float01.hh.

References mln::value::internal::two_pow_n_minus_1(), and val_.


Member Function Documentation

unsigned mln::value::float01::nbits (  )  const [inline]

Access to the encoding size.

Definition at line 186 of file float01.hh.

References nbits_.

Referenced by mln::value::operator<(), mln::value::operator<<(), and mln::value::operator==().

mln::value::float01::operator float (  )  const [inline]

Conversion to float.

Definition at line 224 of file float01.hh.

References nbits_, mln::value::internal::two_pow_n_minus_1(), and val_.

float01 & mln::value::float01::set_nbits ( unsigned  nbits  )  [inline]

Set the encoding size to nbits.

Definition at line 193 of file float01.hh.

References nbits_, mln::value::internal::two_pow_(), mln::value::internal::two_pow_n_minus_1(), and val_.

Referenced by to_nbits().

const float01 mln::value::float01::to_nbits ( unsigned  nbits  )  const [inline]

Return an equivalent gray encoded on nbits bits.

Definition at line 214 of file float01.hh.

References nbits_, and set_nbits().

Referenced by mln::value::operator<(), and mln::value::operator==().

float mln::value::float01::value (  )  const [inline]

Access to std type.

Definition at line 172 of file float01.hh.

References nbits_, mln::value::internal::two_pow_n_minus_1(), and val_.

Referenced by mln::value::operator<(), and mln::value::operator<<().

unsigned long mln::value::float01::value_ind (  )  const [inline]

Access to the position in the quantized interval.

Definition at line 179 of file float01.hh.

References nbits_, and val_.

Referenced by mln::value::operator==().


Member Data Documentation

unsigned mln::value::float01::nbits_ [protected]

Encoding size.

Definition at line 100 of file float01.hh.

Referenced by nbits(), operator float(), set_nbits(), to_nbits(), value(), and value_ind().

unsigned long mln::value::float01::val_ [protected]

Value.

Definition at line 103 of file float01.hh.

Referenced by float01(), operator float(), set_nbits(), value(), and value_ind().