eXpress “1.5”

CovarTable Class Reference

The CovarTable is a sparse matrix for storing and updating pairwise covariances between targets. More...

#include <bundles.h>

List of all members.

Public Member Functions

 CovarTable ()
 CovarTable Constructor.
void increment (TargID targ1, TargID targ2, double covar)
 A member function that increases the covariance between two targets by the specified amount (logged).
double get (TargID targ1, TargID targ2)
 A member function that returns the covariance between two targets.
size_t size () const
 A member function that returns the number of pairs of targets with non-zero covariance.

Detailed Description

The CovarTable is a sparse matrix for storing and updating pairwise covariances between targets.

Author:
Adam Roberts
Date:
2011 Artistic License 2.0

Definition at line 28 of file bundles.h.


Member Function Documentation

double CovarTable::get ( TargID  targ1,
TargID  targ2 
)

A member function that returns the covariance between two targets.

The returned value will be the the negative of the true value (logged).

Parameters:
targ1one of the targets in the pair.
targ2the other target in the pair.
Returns:
The negative of the pair's covariance (logged).

Definition at line 25 of file bundles.cpp.

void CovarTable::increment ( TargID  targ1,
TargID  targ2,
double  covar 
)

A member function that increases the covariance between two targets by the specified amount (logged).

These values are stored positive even though the true covariance is negative.

Parameters:
targ1one of the targets in the pair.
targ2the other target in the pair.
covara double specifying the amount to increase the pair's covariance by (logged, positive).

Definition at line 16 of file bundles.cpp.

size_t CovarTable::size ( ) const [inline]

A member function that returns the number of pairs of targets with non-zero covariance.

Returns:
The number of target pairs with non-zero covariance.

Definition at line 64 of file bundles.h.


The documentation for this class was generated from the following files:
 All Classes Functions Variables