Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

T_Uneven_Partition Class Reference

#include <T_Uneven_Partition.h>

Inheritance diagram for T_Uneven_Partition:

I_Partition List of all members.

Public Types

typedef T_Point Mapped_Point
typedef T_Uneven_Partition Like_Current
typedef HTL_STD::vector< T_Point > Points_Set
typedef T_Uneven_Partition T__Partition

Public Methods

 H_IID_IMPLEMENT (T_Uneven_Partition)
 Very simple RTTI feature.

virtual ~T_Uneven_Partition ()
 Destructor.

 T_Uneven_Partition ()
 Empty constructor.

 T_Uneven_Partition (HTL_STD::vector< float > &some_points, End_Point_Convention a_convention=RIGHT_OPEN)
 Construct an elementary partition which is delimited by a vector of floats.

 T_Uneven_Partition (HTL_STD::vector< double > &some_points, End_Point_Convention a_convention=RIGHT_OPEN)
 Construct an elementary partition which is delimited by a vector of doubles.

 T_Uneven_Partition (I_Partition &another)
 Construct a new T_Uneven_Partition out of another I_Partition.

virtual double i_bin_width (Index i) const
 Number of bin indexes that are not in range.

virtual Size bin_count () const
 Number of in-range bin indexes.

virtual double i_lower_point () const
 Leftmost point of the partition.

virtual double i_upper_point () const
 Rightmost point of the partition.

virtual double i_lower_point (Index i) const
 Leftmost point of bin indexed by i .

virtual double i_upper_point (Index i) const
 Rightmost point of bin indexed by i .

virtual void map_point (double a_point, Index &_index, Extra_Index &_exindex)
 Bin mapped to point a_point.

void map_index (T_Point a_point, Index &an_index, Extra_Index &an_extra_index)
 Map a_point to a bin index.

void map_index1 (T_Point a_point, Index &_index, Extra_Index &_extra_index)
 Map a_point to a bin index.

T_Point bin_width (Index i) const
 Width of the bin indexed by i .

T_Point lower_point () const
 Same as left-most point of the partition.

T_Point upper_point () const
 Same as right-most point of the partition.

T_Point lower_point (Index i) const
 Left-most point of the in-range bin whose index is i .

T_Point upper_point (Index i) const
 Right-most point of the in-range bin whose index is i .

virtual End_Point_Convention end_point_convention () const
 End point convention: the same for all of the bins.


Protected Methods

void initializePartition ()

Protected Attributes

T_Point lower_point_
T_Point upper_point_
Size count_
End_Point_Convention end_point_convention_
Points_Set points_

Member Typedef Documentation

typedef T_Uneven_Partition T_Uneven_Partition::Like_Current
 

Definition at line 24 of file T_Uneven_Partition.h.

typedef T_Point T_Uneven_Partition::Mapped_Point
 

Definition at line 23 of file T_Uneven_Partition.h.

typedef HTL_STD::vector<T_Point> T_Uneven_Partition::Points_Set
 

Definition at line 25 of file T_Uneven_Partition.h.

typedef T_Uneven_Partition T_Uneven_Partition::T__Partition
 

Definition at line 26 of file T_Uneven_Partition.h.


Constructor & Destructor Documentation

virtual T_Uneven_Partition::~T_Uneven_Partition   [inline, virtual]
 

Definition at line 29 of file T_Uneven_Partition.h.

T_Uneven_Partition::T_Uneven_Partition   [inline]
 

Definition at line 31 of file T_Uneven_Partition.h.

T_Uneven_Partition::T_Uneven_Partition HTL_STD::vector< float > &    some_points,
End_Point_Convention    a_convention = RIGHT_OPEN
 

All of the delimited intervals have the same endpoint convention which is a_convention.

T_Uneven_Partition::T_Uneven_Partition HTL_STD::vector< double > &    some_points,
End_Point_Convention    a_convention = RIGHT_OPEN
 

All of the delimited intervals have the same endpoint convention which is a_convention.

T_Uneven_Partition::T_Uneven_Partition I_Partition   another
 


Member Function Documentation

virtual Size T_Uneven_Partition::bin_count   const [inline, virtual]
 

Implements I_Partition.

Definition at line 71 of file T_Uneven_Partition.h.

References count_, and Size.

Referenced by bin_width(), and map_index().

T_Point T_Uneven_Partition::bin_width Index    i const [inline]
 

Definition at line 128 of file T_Uneven_Partition.h.

References bin_count(), HTL_ERR, Index, points_, and T_Point.

Referenced by i_bin_width().

virtual End_Point_Convention T_Uneven_Partition::end_point_convention   const [inline, virtual]
 

Implements I_Partition.

Definition at line 169 of file T_Uneven_Partition.h.

References End_Point_Convention, and end_point_convention_.

T_Uneven_Partition::H_IID_IMPLEMENT T_Uneven_Partition   
 

virtual double T_Uneven_Partition::i_bin_width Index    i const [inline, virtual]
 

Implements I_Partition.

Definition at line 68 of file T_Uneven_Partition.h.

References bin_width(), and Index.

virtual double T_Uneven_Partition::i_lower_point Index    i const [inline, virtual]
 

Implements I_Partition.

Definition at line 80 of file T_Uneven_Partition.h.

References Index, and lower_point().

virtual double T_Uneven_Partition::i_lower_point   const [inline, virtual]
 

Implements I_Partition.

Definition at line 74 of file T_Uneven_Partition.h.

References lower_point().

virtual double T_Uneven_Partition::i_upper_point Index    i const [inline, virtual]
 

Implements I_Partition.

Definition at line 83 of file T_Uneven_Partition.h.

References Index, and upper_point().

virtual double T_Uneven_Partition::i_upper_point   const [inline, virtual]
 

Implements I_Partition.

Definition at line 77 of file T_Uneven_Partition.h.

References upper_point().

void T_Uneven_Partition::initializePartition   [protected]
 

T_Point T_Uneven_Partition::lower_point Index    i const [inline]
 

Definition at line 148 of file T_Uneven_Partition.h.

References count_, HTL_ERR, Index, points_, and T_Point.

T_Point T_Uneven_Partition::lower_point   const [inline]
 

The returned type is more specialized.

Definition at line 140 of file T_Uneven_Partition.h.

References lower_point_, and T_Point.

Referenced by i_lower_point().

void T_Uneven_Partition::map_index T_Point    a_point,
Index   an_index,
Extra_Index   an_extra_index
[inline]
 

The mapped index is passed to an_index when the mapped bin is in range, i.e when the value passed to an_extra_index equals H_IN_RANGE. If an_extra_index equals H_UNDERFLOW or H_OVERFLOW, one cannot not rely on the value passed to an_index: it is undefined. This is a fast inline function which handle the most common case. More complex cases are managed by the non-inlined method map_index1

Definition at line 100 of file T_Uneven_Partition.h.

References bin_count(), end_point_convention_, Extra_Index, H_IN_RANGE, Index, lower_point_, map_index1(), RIGHT_OPEN, T_Point, upper_point(), and upper_point_.

Referenced by map_point().

void T_Uneven_Partition::map_index1 T_Point    a_point,
Index   _index,
Extra_Index   _extra_index
 

The mapped index is passed to an_index when the mapped bin is in range, i.e when the value passed to an_extra_index equals H_IN_RANGE. If an_extra_index equals H_UNDERFLOW or H_OVERFLOW, one cannot not rely on the value passed to an_index: it is undefined.

Referenced by map_index().

virtual void T_Uneven_Partition::map_point double    a_point,
Index   _index,
Extra_Index   _exindex
[inline, virtual]
 

Implements I_Partition.

Definition at line 86 of file T_Uneven_Partition.h.

References Extra_Index, Index, and map_index().

T_Point T_Uneven_Partition::upper_point Index    i const [inline]
 

Definition at line 158 of file T_Uneven_Partition.h.

References count_, HTL_ERR, Index, points_, and T_Point.

T_Point T_Uneven_Partition::upper_point   const [inline]
 

The returned type is more specialized.

Definition at line 145 of file T_Uneven_Partition.h.

References T_Point, and upper_point_.

Referenced by i_upper_point(), and map_index().


Member Data Documentation

Size T_Uneven_Partition::count_ [protected]
 

Definition at line 178 of file T_Uneven_Partition.h.

Referenced by bin_count(), lower_point(), and upper_point().

End_Point_Convention T_Uneven_Partition::end_point_convention_ [protected]
 

Definition at line 179 of file T_Uneven_Partition.h.

Referenced by end_point_convention(), and map_index().

T_Point T_Uneven_Partition::lower_point_ [protected]
 

Definition at line 176 of file T_Uneven_Partition.h.

Referenced by lower_point(), and map_index().

Points_Set T_Uneven_Partition::points_ [protected]
 

Definition at line 180 of file T_Uneven_Partition.h.

Referenced by bin_width(), lower_point(), and upper_point().

T_Point T_Uneven_Partition::upper_point_ [protected]
 

Definition at line 177 of file T_Uneven_Partition.h.

Referenced by map_index(), and upper_point().


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

Anaphe documentation generated by Doxygen (www.doxygen.org)