$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::value::int_u_sat< n > Struct Template Reference

#include <mln/value/int_u_sat.hh>

Public Member Functions

 int_u_sat ()
 int_u_sat (int i)
C & handle_ ()
 operator int () const
int_u_sat< n > & operator+= (int i)
int_u_sat< n > & operator-= (int i)
int_u_sat< n > & operator= (int i)
const C & to_enc () const
to_equiv () const
to_interop () const

Static Public Attributes

static const int_u_sat< n > one
static const int_u_sat< n > zero

Protected Attributes

enc v_

Public Types

typedef Integer< void > category
typedef C enc
typedef V equiv
typedef int_u_sat< n > exact_t
typedef N interop

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.

Constructor & Destructor Documentation

template<unsigned n>
mln::value::int_u_sat< n >::int_u_sat ( )

Constructor without argument.

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

Constructor from an integer.

Member Function Documentation

template<typename V, typename C, typename N, typename E>
C& mln::value::internal::value_like_< V, C, N, E >::handle_ ( )
inlineinherited

Definition at line 81 of file value_like.hh.

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

Conversion to an integer.

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

Self addition.

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

Self subtraction.

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

Assignment from an integer.

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

Explicit conversion towards encoding type.

template<typename V, typename C, typename N, typename E>
V mln::value::internal::value_like_< V, C, N, E >::to_equiv ( ) const
inherited

Explicit conversion towards equivalent type.

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

Explicit conversion towards interoperation type.

Member Data Documentation

template<unsigned n>
const int_u_sat<n> mln::value::int_u_sat< n >::one
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_
protectedinherited

Definition at line 84 of file value_like.hh.

template<unsigned n>
const int_u_sat<n> mln::value::int_u_sat< n >::zero
static

Zero value.

Definition at line 112 of file int_u_sat.hh.

Member Typedef Documentation

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

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.

Definition at line 65 of file value_like.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.

Definition at line 62 of file value_like.hh.

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

Definition at line 105 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 68 of file value_like.hh.