---

more::phys::confidence_interval Class Template Reference

A type for storing a value and its deviation. More...

#include <more/phys/confidence_interval.h>

Inheritance diagram for more::phys::confidence_interval:

[legend]Collaboration diagram for more::phys::confidence_interval:

[legend]List of all members.

Public Types

• typedef origin_t origin_type

Public Methods

• confidence_interval ()

  Constuct an completely undefined value. More...
  
  

• confidence_interval (infinite_tag, origin_type origin=origin_unknown, unsigned int moment=2)

  Construct an infinite value. More...
  
  

• confidence_interval (infinite_tag, unknown_tag, origin_type origin=origin_unknown, unsigned int moment=2)

  Construct an "approximately infinite" value. More...
  
  

• confidence_interval (T const &x, T const &s, origin_type origin=origin_unknown, unsigned int moment=2)

  Construct a symmetric confidence interval centered at x with standard deviation s. More...
  
  

• confidence_interval (T const &x, T const &s_mi, T const &s_pl, origin_type origin=origin_unknown, unsigned int moment=2)

  Construct an asymmetric confidence interval centered at x with deviations m_mi below and s_pl above. More...
  
  

• confidence_interval (T const &x, T const &s_mi, infinite_tag, origin_type origin=origin_unknown, unsigned int moment=2)

  Construct a lower bound x with deviation s_mi. More...
  
  

• confidence_interval (T const &x, infinite_tag, T const &s_pl, origin_type origin=origin_unknown, unsigned int moment=2)

  Construct an upper bound x with deviation s_pl. More...
  
  

• confidence_interval (T const &x, unknown_tag, origin_type origin=origin_unknown)

  Construct an approximate value x with unspecified deviation. More...
  
  

• origin_type origin () const

  Return generic information on the origin of the value. More...
  
  

• void set_origin (origin_type o)

  Set the generic origin of the value. More...
  
  

• void be_uncertain ()
• bool is_uncertain () const
• void be_signless ()
• bool is_signless () const
• bool is_known () const

  True if the value is defined is some way. More...
  
  

• bool is_finite () const

  True if the valus is known and finite. More...
  
  

• bool is_inf () const

  True if an infinite value. More...
  
  

• bool dev_below_is_known () const

  True if the lower deviation is given. More...
  
  

• bool dev_above_is_known () const

  True if the upper deviation is given. More...
  
  

• bool dev_below_is_finite () const

  Deviation below is known and finite. More...
  
  

• bool dev_above_is_finite () const

  Deviation above is known and finite. More...
  
  

• bool dev_below_is_inf () const

  Deviation below is known and infinite. More...
  
  

• bool dev_above_is_inf () const

  Deviation above is known and infinite. More...
  
  

• bool is_symmetric () const

  True if the deviation above and below are the same. More...
  
  

• bool is_exact () const

  True if exact within the numeric precision. More...
  
  

• T cent () const

  Center of the confidence interval. More...
  
  

• T min () const

  Minimum value in the confidence interval. More...
  
  

• T max () const

  Maximum value in the confidence interval. More...
  
  

• T dev () const

  Return max(dev_above(), dev_below()). More...
  
  

• T rdev () const

  Return abs(cent())/dev(). More...
  
  

• T dev_below () const

  The deviation below the central value. More...
  
  

• T dev_above () const

  The deviation above the central value. More...
  
  

• confidence_interval & operator *= (T x)
• confidence_interval & operator/= (T x)
• confidence_interval & operator+= (confidence_interval const &rhs)
• confidence_interval & operator-= (confidence_interval const &rhs)
• void negate ()
• void sync (io::syncstream &)

Static Public Attributes

• more::phys::confidence_interval::unknown_tag unknown
• more::phys::confidence_interval::infinite_tag infinite

---

Detailed Description

template<typename T>
class more::phys::confidence_interval< T >

A type for storing a value and its deviation.

Precondition:

T is a floating point number. Moment > 0.

---

Member Typedef Documentation

template<typename T> typedef origin_t more::phys::confidence_interval::origin_type

---

Constructor & Destructor Documentation

template<typename T> more::phys::confidence_interval< T >::confidence_interval (    )  [inline]

Constuct an completely undefined value.

template<typename T> more::phys::confidence_interval< T >::confidence_interval (  infinite_tag   , origin_type    origin = origin_unknown, unsigned int    moment = 2 )  [inline]

Construct an infinite value.

template<typename T> more::phys::confidence_interval< T >::confidence_interval (  infinite_tag   , unknown_tag   , origin_type    origin = origin_unknown, unsigned int    moment = 2 )  [inline]

Construct an "approximately infinite" value. Typically this may express a value which are unknown because it is too large too detect with present technology.

template<typename T> more::phys::confidence_interval< T >::confidence_interval (  T const &    x, T const &    s, origin_type    origin = origin_unknown, unsigned int    moment = 2 )  [inline]

Construct a symmetric confidence interval centered at x with standard deviation s.

template<typename T> more::phys::confidence_interval< T >::confidence_interval (  T const &    x, T const &    s_mi, T const &    s_pl, origin_type    origin = origin_unknown, unsigned int    moment = 2 )  [inline]

Construct an asymmetric confidence interval centered at x with deviations m_mi below and s_pl above.

template<typename T> more::phys::confidence_interval< T >::confidence_interval (  T const &    x, T const &    s_mi, infinite_tag   , origin_type    origin = origin_unknown, unsigned int    moment = 2 )  [inline]

Construct a lower bound x with deviation s_mi.

template<typename T> more::phys::confidence_interval< T >::confidence_interval (  T const &    x, infinite_tag   , T const &    s_pl, origin_type    origin = origin_unknown, unsigned int    moment = 2 )  [inline]

Construct an upper bound x with deviation s_pl.

template<typename T> more::phys::confidence_interval< T >::confidence_interval (  T const &    x, unknown_tag   , origin_type    origin = origin_unknown )  [inline]

Construct an approximate value x with unspecified deviation. Approximate values are synced with 10 bits precition (œôøå 3 digits).

---

Member Function Documentation

template<typename T> void more::phys::confidence_interval< T >::be_signless (    )  [inline]

template<typename T> void more::phys::confidence_interval< T >::be_uncertain (    )  [inline]

template<typename T> T more::phys::confidence_interval< T >::cent (    )  const [inline]

Center of the confidence interval.

template<typename T> T more::phys::confidence_interval< T >::dev (    )  const [inline]

Return max(dev_above(), dev_below()).

template<typename T> T more::phys::confidence_interval< T >::dev_above (    )  const [inline]

The deviation above the central value.

template<typename T> bool more::phys::confidence_interval< T >::dev_above_is_finite (    )  const [inline]

Deviation above is known and finite.

template<typename T> bool more::phys::confidence_interval< T >::dev_above_is_inf (    )  const [inline]

Deviation above is known and infinite.

template<typename T> bool more::phys::confidence_interval< T >::dev_above_is_known (    )  const [inline]

True if the upper deviation is given.

template<typename T> T more::phys::confidence_interval< T >::dev_below (    )  const [inline]

The deviation below the central value.

template<typename T> bool more::phys::confidence_interval< T >::dev_below_is_finite (    )  const [inline]

Deviation below is known and finite.

template<typename T> bool more::phys::confidence_interval< T >::dev_below_is_inf (    )  const [inline]

Deviation below is known and infinite.

template<typename T> bool more::phys::confidence_interval< T >::dev_below_is_known (    )  const [inline]

True if the lower deviation is given.

template<typename T> bool more::phys::confidence_interval< T >::is_exact (    )  const [inline]

True if exact within the numeric precision.

template<typename T> bool more::phys::confidence_interval< T >::is_finite (    )  const [inline]

True if the valus is known and finite.

template<typename T> bool more::phys::confidence_interval< T >::is_inf (    )  const [inline]

True if an infinite value.

template<typename T> bool more::phys::confidence_interval< T >::is_known (    )  const [inline]

True if the value is defined is some way.

template<typename T> bool more::phys::confidence_interval< T >::is_signless (    )  const [inline]

template<typename T> bool more::phys::confidence_interval< T >::is_symmetric (    )  const [inline]

True if the deviation above and below are the same.

template<typename T> bool more::phys::confidence_interval< T >::is_uncertain (    )  const [inline]

template<typename T> T more::phys::confidence_interval< T >::max (    )  const [inline]

Maximum value in the confidence interval.

template<typename T> T more::phys::confidence_interval< T >::min (    )  const [inline]

Minimum value in the confidence interval.

template<typename T> void more::phys::confidence_interval< T >::negate (    )  [inline]

template<typename T> confidence_interval& more::phys::confidence_interval< T >::operator *= (  T    x )  [inline]

template<typename T> confidence_interval& more::phys::confidence_interval< T >::operator+= (  confidence_interval< T > const &    rhs )  [inline]

template<typename T> confidence_interval& more::phys::confidence_interval< T >::operator-= (  confidence_interval< T > const &    rhs )  [inline]

template<typename T> confidence_interval& more::phys::confidence_interval< T >::operator/= (  T    x )  [inline]

template<typename T> origin_type more::phys::confidence_interval< T >::origin (    )  const [inline]

Return generic information on the origin of the value.

template<typename T> T more::phys::confidence_interval< T >::rdev (    )  const [inline]

Return abs(cent())/dev().

template<typename T> void more::phys::confidence_interval< T >::set_origin (  origin_type    o )  [inline]

Set the generic origin of the value.

template<typename T> void more::phys::confidence_interval< T >::sync (  io::syncstream &    )

---

Member Data Documentation

template<typename T> struct more::phys::confidence_interval::infinite_tag more::phys::confidence_interval::infinite [static]

template<typename T> struct more::phys::confidence_interval::unknown_tag more::phys::confidence_interval::unknown [static]

---

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

• more/phys/confidence_interval.h

---