Public Types | Public Member Functions | Protected Attributes
bsta_von_mises< T, n > Class Template Reference

A Von_Mises distribution. More...

#include <bsta_von_mises.h>

Inheritance diagram for bsta_von_mises< T, n >:
Inheritance graph
[legend]

List of all members.

Public Types

enum  { data_dimension = n }
typedef bsta_distribution< T,
n >::vector_type 
vector_type
 The type used for a n-dimensional vector of math types.
typedef bsta_distribution< T,
n >::math_type 
math_type
 The type used for calculations.
typedef bsta_distribution< T,
n >::field_type 
field_type
 for compatibility with vpdl/vpdt.
enum  { dimension = n }
 The dimension of the distribution. More...

Public Member Functions

 bsta_von_mises ()
 bsta_von_mises (vector_type const &mean, T kappa)
virtual ~bsta_von_mises ()
const vector_typemean () const
 The mean vector.
void set_mean (const vector_type &mean)
kappa () const
 the concentration parameter (kappa).
void set_kappa (T kappa)
prob_density (vector_type const &v) const
 The probability density at a given unit vector.
probability (vector_type const &v, const T theta_max) const
 Probability of an angular range of vectors about v, which defines a cone.

Protected Attributes

vector_type mean_
 The mean vector.
kappa_
 The concentration parameter (kappa).

Detailed Description

template<class T, unsigned n>
class bsta_von_mises< T, n >

A Von_Mises distribution.

Definition at line 25 of file bsta_von_mises.h.


Member Typedef Documentation

template<class T, unsigned n>
typedef bsta_distribution<T,n>::field_type bsta_von_mises< T, n >::field_type

for compatibility with vpdl/vpdt.

Reimplemented from bsta_distribution< T, n >.

Definition at line 30 of file bsta_von_mises.h.

template<class T, unsigned n>
typedef bsta_distribution<T,n>::math_type bsta_von_mises< T, n >::math_type

The type used for calculations.

Reimplemented from bsta_distribution< T, n >.

Definition at line 29 of file bsta_von_mises.h.

template<class T, unsigned n>
typedef bsta_distribution<T,n>::vector_type bsta_von_mises< T, n >::vector_type

The type used for a n-dimensional vector of math types.

Reimplemented from bsta_distribution< T, n >.

Definition at line 28 of file bsta_von_mises.h.


Member Enumeration Documentation

template<class T, unsigned n>
anonymous enum [inherited]

The dimension of the distribution.

Enumerator:
dimension 

Definition at line 23 of file bsta_distribution.h.

template<class T, unsigned n>
anonymous enum
Enumerator:
data_dimension 

Definition at line 31 of file bsta_von_mises.h.


Constructor & Destructor Documentation

template<class T, unsigned n>
bsta_von_mises< T, n >::bsta_von_mises ( ) [inline]

Definition at line 32 of file bsta_von_mises.h.

template<class T, unsigned n>
bsta_von_mises< T, n >::bsta_von_mises ( vector_type const &  mean,
kappa 
) [inline]

Definition at line 33 of file bsta_von_mises.h.

template<class T, unsigned n>
virtual bsta_von_mises< T, n >::~bsta_von_mises ( ) [inline, virtual]

Definition at line 34 of file bsta_von_mises.h.


Member Function Documentation

template<class T, unsigned n>
T bsta_von_mises< T, n >::kappa ( ) const [inline]

the concentration parameter (kappa).

Definition at line 40 of file bsta_von_mises.h.

template<class T, unsigned n>
const vector_type& bsta_von_mises< T, n >::mean ( ) const [inline]

The mean vector.

Definition at line 36 of file bsta_von_mises.h.

template<class T, unsigned n>
T bsta_von_mises< T, n >::prob_density ( vector_type const &  v) const [inline]

The probability density at a given unit vector.

Definition at line 44 of file bsta_von_mises.h.

template<class T, unsigned n>
T bsta_von_mises< T, n >::probability ( vector_type const &  v,
const T  theta_max 
) const [inline]

Probability of an angular range of vectors about v, which defines a cone.

Definition at line 47 of file bsta_von_mises.h.

template<class T, unsigned n>
void bsta_von_mises< T, n >::set_kappa ( kappa) [inline]

Definition at line 41 of file bsta_von_mises.h.

template<class T, unsigned n>
void bsta_von_mises< T, n >::set_mean ( const vector_type mean) [inline]

Definition at line 37 of file bsta_von_mises.h.


Member Data Documentation

template<class T, unsigned n>
T bsta_von_mises< T, n >::kappa_ [protected]

The concentration parameter (kappa).

Definition at line 53 of file bsta_von_mises.h.

template<class T, unsigned n>
vector_type bsta_von_mises< T, n >::mean_ [protected]

The mean vector.

Definition at line 51 of file bsta_von_mises.h.


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