DGtal  0.9.4beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CBinner< T > Struct Template Reference

#include <DGtal/math/CBinner.h>

Inheritance diagram for DGtal::concepts::CBinner< T >:
[legend]
Collaboration diagram for DGtal::concepts::CBinner< T >:
[legend]

Public Types

typedef T::Quantity Quantity
 
typedef T::Bin Bin
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CEuclideanRing< Quantity >))
 
 BOOST_STATIC_ASSERT ((boost::is_integral< Bin >::value))
 
 BOOST_STATIC_ASSERT ((boost::is_unsigned< Bin >::value))
 
 BOOST_CONCEPT_USAGE (CBinner)
 
void checkConstConstraints () const
 

Private Attributes

myX
 
Quantity myQ
 
Bin myBin
 
T * myClone
 

Detailed Description

template<typename T>
struct DGtal::concepts::CBinner< T >

Aim: Represents an object that places a quantity into a bin, i.e. a functor that associates a natural integer to a continuous value.

Description of concept 'CBinner'

It is used for instance when computing an histogram over samples of a continuous random variable.

Refinement of boost::CopyConstructible

Associated types :

Notation

Definitions

Valid expressions and semantics

| Name | Expression | Type requirements | Return type | Precondition | Semantics | Post condition | Complexity | |----—|---------—|----------------—|------------—|-----------—|--------—|-------------—|---------—| | construction | X( m, M, n ) | m and M are Quantity, n is a Bin | | | | Constructs a binner with n bins and range from m to M | | | | apply | x( q ) | q is a Quantity | Bin | | returns the bin in which fall q | | |

Invariants

Models

Notes

Template Parameters
Tthe type that should be a model of CBinner.

Definition at line 97 of file CBinner.h.

Member Typedef Documentation

template<typename T >
typedef T::Bin DGtal::concepts::CBinner< T >::Bin

Definition at line 102 of file CBinner.h.

template<typename T >
typedef T::Quantity DGtal::concepts::CBinner< T >::Quantity

Definition at line 101 of file CBinner.h.

Member Function Documentation

template<typename T >
DGtal::concepts::CBinner< T >::BOOST_CONCEPT_ASSERT ( (CEuclideanRing< Quantity >)  )
template<typename T >
DGtal::concepts::CBinner< T >::BOOST_CONCEPT_USAGE ( CBinner< T >  )
inline
template<typename T >
DGtal::concepts::CBinner< T >::BOOST_STATIC_ASSERT ( (boost::is_integral< Bin >::value)  )
template<typename T >
DGtal::concepts::CBinner< T >::BOOST_STATIC_ASSERT ( (boost::is_unsigned< Bin >::value)  )
template<typename T >
void DGtal::concepts::CBinner< T >::checkConstConstraints ( ) const
inline

Field Documentation

template<typename T >
Bin DGtal::concepts::CBinner< T >::myBin
private
template<typename T >
T* DGtal::concepts::CBinner< T >::myClone
private

Definition at line 122 of file CBinner.h.

Referenced by DGtal::concepts::CBinner< T >::BOOST_CONCEPT_USAGE().

template<typename T >
Quantity DGtal::concepts::CBinner< T >::myQ
private
template<typename T >
T DGtal::concepts::CBinner< T >::myX
private

Definition at line 119 of file CBinner.h.

Referenced by DGtal::concepts::CBinner< T >::checkConstConstraints().


The documentation for this struct was generated from the following file: