Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | Private Types

mln::value::int_u_sat< n > Struct Template Reference

Unsigned integer value class with saturation behavior. More...

#include <int_u_sat.hh>

Inheritance diagram for mln::value::int_u_sat< n >:
Inheritance graph

List of all members.

Public Types

typedef Integer< void > category
typedef C enc
 Encoding associated type.
typedef V equiv
 Equivalent associated type.
typedef int_u_sat< n > exact_t
typedef N interop
 Interoperation associated type.

Public Member Functions

C & handle_ ()
 int_u_sat ()
 Constructor without argument.
 int_u_sat (int i)
 Constructor from an integer.
 operator int () const
 Conversion to an integer.
int_u_sat< n > & operator+= (int i)
 Self addition.
int_u_sat< n > & operator-= (int i)
 Self subtraction.
int_u_sat< n > & operator= (int i)
 Assignment from an integer.
const C & to_enc () const
 Explicit conversion towards encoding type.
to_equiv () const
 Explicit conversion towards equivalent type.
to_interop () const
 Explicit conversion towards interoperation type.

Static Public Attributes

static const int_u_sat< n > one = 1
 Unit value.
static const int_u_sat< n > zero = 0
 Zero value.

Protected Attributes

enc v_

Private Types

typedef int_u< n >::enc enc_

Detailed Description

template<unsigned n>
struct mln::value::int_u_sat< n >

Unsigned integer value class with saturation behavior.

The parameter is n the number of encoding bits.

Definition at line 90 of file int_u_sat.hh.


Member Typedef Documentation

typedef Integer<void> mln::value::Integer< int_u_sat< n > >::category [inherited]

Reimplemented from mln::value::Scalar< int_u_sat< n > >.

Definition at line 60 of file concept/integer.hh.

template<typename V, typename C, typename N, typename E>
typedef C mln::value::internal::value_like_< V, C, N, E >::enc [inherited]

Encoding associated type.

Reimplemented in mln::value::internal::gray_< n >, and mln::value::label< n >.

Definition at line 60 of file value_like.hh.

template<unsigned n>
typedef int_u<n>::enc mln::value::int_u_sat< n >::enc_ [private]

Definition at line 124 of file int_u_sat.hh.

template<typename V, typename C, typename N, typename E>
typedef V mln::value::internal::value_like_< V, C, N, E >::equiv [inherited]

Equivalent associated type.

Reimplemented in mln::value::internal::gray_< n >.

Definition at line 57 of file value_like.hh.

typedef int_u_sat< n > mln::Object< int_u_sat< n > >::exact_t [inherited]

Definition at line 173 of file object.hh.

template<typename V, typename C, typename N, typename E>
typedef N mln::value::internal::value_like_< V, C, N, E >::interop [inherited]

Interoperation associated type.

Definition at line 63 of file value_like.hh.


Constructor & Destructor Documentation

template<unsigned n>
mln::value::int_u_sat< n >::int_u_sat (  )  [inline]

Constructor without argument.

Definition at line 149 of file int_u_sat.hh.

template<unsigned n>
mln::value::int_u_sat< n >::int_u_sat ( int  i  )  [inline]

Constructor from an integer.

Definition at line 155 of file int_u_sat.hh.

References mln::value::internal::value_like_< V, C, N, E >::v_.


Member Function Documentation

template<typename V, typename C, typename N, typename E>
C& mln::value::internal::value_like_< V, C, N, E >::handle_ (  )  [inline, inherited]

Definition at line 76 of file value_like.hh.

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

template<unsigned n>
mln::value::int_u_sat< n >::operator int (  )  const [inline]

Conversion to an integer.

Definition at line 170 of file int_u_sat.hh.

References mln::value::internal::value_like_< V, C, N, E >::v_.

template<unsigned n>
int_u_sat< n > & mln::value::int_u_sat< n >::operator+= ( int  i  )  [inline]

Self addition.

Definition at line 195 of file int_u_sat.hh.

References mln::value::internal::value_like_< V, C, N, E >::v_.

template<unsigned n>
int_u_sat< n > & mln::value::int_u_sat< n >::operator-= ( int  i  )  [inline]

Self subtraction.

Definition at line 205 of file int_u_sat.hh.

References mln::value::internal::value_like_< V, C, N, E >::v_.

template<unsigned n>
int_u_sat< n > & mln::value::int_u_sat< n >::operator= ( int  i  )  [inline]

Assignment from an integer.

Definition at line 178 of file int_u_sat.hh.

References mln::value::internal::value_like_< V, C, N, E >::v_.

template<typename V , typename C , typename N , typename E >
const C & mln::value::internal::value_like_< V, C, N, E >::to_enc (  )  const [inline, inherited]
template<typename V , typename C , typename N , typename E >
V mln::value::internal::value_like_< V, C, N, E >::to_equiv (  )  const [inline, inherited]

Explicit conversion towards equivalent type.

Definition at line 102 of file value_like.hh.

References mln::value::internal::value_like_< V, C, N, E >::v_.

Referenced by mln::convert::over_load::from_to_().

template<typename V , typename C , typename N , typename E >
N mln::value::internal::value_like_< V, C, N, E >::to_interop (  )  const [inline, inherited]

Member Data Documentation

template<unsigned n>
const int_u_sat< n > mln::value::int_u_sat< n >::one = 1 [static]

Unit value.

Definition at line 115 of file int_u_sat.hh.

template<typename V, typename C, typename N, typename E>
enc mln::value::internal::value_like_< V, C, N, E >::v_ [protected, inherited]

Definition at line 79 of file value_like.hh.

Referenced by mln::value::qt::rgb32::blue(), mln::value::rgb< n >::blue(), mln::value::qt::rgb32::comp(), mln::value::rgb< n >::comp(), mln::value::float01_< n >::float01_(), mln::value::float01_f::float01_f(), mln::value::internal::gray_< n >::gray_(), mln::value::internal::gray_f::gray_f(), mln::value::graylevel< n >::graylevel(), mln::value::graylevel_f::graylevel_f(), mln::value::qt::rgb32::green(), mln::value::rgb< n >::green(), mln::value::internal::value_like_< int, int, gray_< n >, gray_< n > >::handle_(), mln::value::int_s< n >::int_s(), mln::value::int_u< n >::int_u(), mln::value::int_u_sat< n >::int_u_sat(), mln::algebra::quat::inv(), mln::algebra::quat::is_null(), mln::algebra::quat::is_pure(), mln::algebra::quat::is_unit(), mln::value::label< n >::label(), mln::value::label< n >::next(), mln::value::int_u< n >::next(), mln::value::qt::rgb32::operator algebra::vec< 3, float >(), mln::value::rgb< n >::operator algebra::vec< 3, float >(), mln::value::qt::rgb32::operator algebra::vec< 3, int >(), mln::value::rgb< n >::operator algebra::vec< 3, int >(), mln::algebra::quat::operator const algebra::vec< 4, float > &(), mln::value::float01_f::operator float(), mln::value::float01_< n >::operator float(), mln::value::internal::gray_f::operator gray_< m >(), mln::value::internal::gray_< n >::operator gray_< m >(), mln::value::internal::gray_f::operator graylevel< m >(), mln::value::internal::gray_< n >::operator graylevel< m >(), mln::value::internal::gray_f::operator graylevel_f(), mln::value::internal::gray_< n >::operator graylevel_f(), mln::value::int_u_sat< n >::operator int(), mln::value::int_u< n >::operator unsigned(), mln::value::label< n >::operator++(), mln::value::int_u_sat< n >::operator+=(), mln::value::int_u< n >::operator-(), mln::value::label< n >::operator--(), mln::value::int_u_sat< n >::operator-=(), mln::value::qt::rgb32::operator=(), mln::value::rgb< n >::operator=(), mln::algebra::quat::operator=(), mln::value::label< n >::operator=(), mln::value::int_u_sat< n >::operator=(), mln::value::int_u< n >::operator=(), mln::value::int_s< n >::operator=(), mln::value::graylevel_f::operator=(), mln::value::graylevel< n >::operator=(), mln::value::internal::gray_f::operator=(), mln::value::internal::gray_< n >::operator=(), mln::value::float01_f::operator=(), mln::value::float01_< n >::operator=(), mln::value::label< n >::prev(), mln::algebra::quat::quat(), mln::value::qt::rgb32::red(), mln::value::rgb< n >::red(), mln::value::rgb< n >::rgb(), mln::value::qt::rgb32::rgb32(), mln::algebra::quat::s(), mln::value::float01_< n >::set_ind(), mln::algebra::quat::set_unit(), mln::algebra::quat::set_v(), mln::algebra::quat::sprod(), mln::value::internal::value_like_< V, C, N, E >::to_enc(), mln::value::internal::value_like_< V, C, N, E >::to_equiv(), mln::value::graylevel< n >::to_float(), mln::algebra::quat::to_vec(), mln::algebra::quat::v(), mln::value::graylevel_f::value(), mln::value::graylevel< n >::value(), mln::value::internal::gray_f::value(), mln::value::internal::gray_< n >::value(), mln::value::float01_f::value(), and mln::value::float01_< n >::value().

template<unsigned n>
const int_u_sat< n > mln::value::int_u_sat< n >::zero = 0 [static]

Zero value.

Definition at line 112 of file int_u_sat.hh.