MD::Formula Class Reference

#include <Formula.h>

Collaboration diagram for MD::Formula:

Public Member Functions
void	testInvariant () const
	effects: test the invariant of this object guarantee: no-fail
	Formula ()
	effects: standard default constructor guarantee: no-fail
	Formula (const std::string &name, const std::string &formula, TTree *tree)
	effects: standard constructor guarantee: strong failures: out of memory II
	~Formula ()
	effects: standard destructor guarantee: no-fail
void	reset (TTree *tree)
	effects: reset this formula to a new tree guarantee: strong failures: out of memory II failures: TTreeFormula error requires: !formula().empty()
const std::string &	formula () const
	description: the formula used guarantee: no-fail
bool	valid () const
	returns: whether the formula is valid guarantee: no-fail
int	ndim () const
	returns: the number of unspecified array dimensions for the given formula guarantee: no-fail requires: valid()
std::size_t	ndata () const
	returns: the number of data entries for the formula with the given index guarantee: strong failures: TTreeFormula errors requires: valid()
Double_t	value (std::size_t data) const
	returns: the result of evaluating the formula with the given index for the given data entry guarantee: strong failures: TTreeFormula errors requires: valid() requires: data < getNData()

Private Member Functions
	Formula (const Formula &that)
	rationale: to avoid broken objects
Formula &	operator= (const Formula &that)

Private Attributes
std::string	m_formula
	description: members directly corresponding to accessors
std::string	m_name
	description: the name we use for the formula
TTree *	m_tree
	description: the tree we are connected to
TTreeFormula *	m_form
	description the formula used
TTreeFormulaManager *	m_manager
	description: the manager used
int	m_ndim
	description: the number of array dimensions we need to loop over, or -1 if we are in error
Long64_t	m_entry
	description: the last entry we read
Int_t	m_ndata
	description: the number of data entries
std::vector< Double_t >	m_cache
	description: the cache of data entries
std::vector< bool >	m_read
	description: whether we read the given data entry

Detailed Description

Definition at line 35 of file Formula.h.

Constructor & Destructor Documentation

Formula() [1/3]

MD::Formula::Formula

(

)

effects: standard default constructor guarantee: no-fail

Definition at line 68 of file Formula.cxx.

    : m_tree (0), m_form (0), m_manager (0), m_ndim (-1),
      m_entry (-1), m_ndata (0)
  {
    RCU_NEW_INVARIANT (this);
  }

Formula() [2/3]

MD::Formula::Formula	(	const std::string &	name,
		const std::string &	formula,
		TTree *	tree )

effects: standard constructor guarantee: strong failures: out of memory II

Definition at line 78 of file Formula.cxx.

    : m_formula (formula), m_name (name),
      m_tree (0), m_form (0), m_manager (0), m_ndim (-1),
      m_entry (-1), m_ndata (0)
  {
    RCU_NEW_INVARIANT (this);
 
    reset (tree);
  }

~Formula()

MD::Formula::~Formula

(

)

effects: standard destructor guarantee: no-fail

Definition at line 91 of file Formula.cxx.

  {
    RCU_DESTROY_INVARIANT (this);
 
    delete m_form;
    m_form = 0;
  }

Formula() [3/3]

MD::Formula::Formula ( const Formula & that )

private

rationale: to avoid broken objects

Member Function Documentation

formula()

const std::string & MD::Formula::formula

(

)

const

description: the formula used guarantee: no-fail

Definition at line 139 of file Formula.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_formula;
  }

ndata()

std::size_t MD::Formula::ndata

(

)

const

returns: the number of data entries for the formula with the given index guarantee: strong failures: TTreeFormula errors requires: valid()

Definition at line 167 of file Formula.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE_SOFT (valid ());
 
    if (m_ndim < 0)
      RCU_THROW_MSG ("invalid formula: " + m_formula);
    if (m_tree->GetReadEntry() != m_entry)
    {
      m_entry = -1;
      m_ndata = m_manager->GetNdata();
      if (m_ndata > 0)
      {
    if (m_read.size() < std::size_t (m_ndata))
      m_read.resize (m_ndata);
    for (std::size_t iter = 0, end = m_ndata; iter != end; ++ iter)
      m_read[iter] = false;
 
    if (m_cache.size() < std::size_t (m_ndata))
      m_cache.resize (m_ndata);
    m_cache[0] = m_form->EvalInstance (0);
    m_read[0] = true;
    m_entry = m_tree->GetReadEntry();
      }
    }
    if (m_ndata < 0)
      RCU_THROW_MSG ("failed to read formula: " + m_formula);
    return m_ndata;
  }

ndim()

int MD::Formula::ndim

(

)

const

returns: the number of unspecified array dimensions for the given formula guarantee: no-fail requires: valid()

Definition at line 157 of file Formula.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE_SOFT (valid ());
    return m_ndim;
  }

operator=()

Formula & MD::Formula::operator= ( const Formula & that )

private

reset()

void MD::Formula::reset

(

TTree *

tree

)

effects: reset this formula to a new tree guarantee: strong failures: out of memory II failures: TTreeFormula error requires: !formula().empty()

Definition at line 102 of file Formula.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
    RCU_REQUIRE (!formula().empty());
 
    delete m_form;
    m_form = 0;
    m_manager = 0;
    m_ndim = -1;
    m_entry = -1;
    m_ndata = 0;
    m_tree = 0;
 
    m_tree = tree;
    m_form = new TTreeFormula (m_name.c_str(), m_formula.c_str(), tree);
 
    m_form->SetQuickLoad (kTRUE);
    m_manager = new TTreeFormulaManager;
    m_manager->Add (m_form);
    m_manager->Sync ();
    if (m_manager->GetMultiplicity () == -1)
      tree->SetBit (TTree::kForceRead);
    if (m_form->GetNdim() <= 0)
      m_ndim = -1;
    else if (m_form->GetMultiplicity() == 0)
      m_ndim = 0;
    else if (m_manager->GetMultiplicity() == 1 && m_form->GetMultiplicity() == 1)
      m_ndim = 1;
    else if (m_manager->GetMultiplicity() == -1 && m_form->GetMultiplicity() == 1)
      m_ndim = 0;
 
    
  }

testInvariant()

void MD::Formula::testInvariant

(

)

const

effects: test the invariant of this object guarantee: no-fail

Definition at line 36 of file Formula.cxx.

  {
    RCU_INVARIANT (this != 0);
    if (!m_formula.empty())
    {
      RCU_INVARIANT (!m_name.empty());
 
      if (m_tree != 0)
      {
    RCU_INVARIANT (m_manager != 0);
    if (m_ndata > 0)
    {
      RCU_INVARIANT (m_cache.size() >= std::size_t (m_ndata));
      RCU_INVARIANT (m_read.size() >= std::size_t (m_ndata));
    }
      } else
      {
    RCU_INVARIANT (m_form == 0);
    RCU_INVARIANT (m_manager == 0);
      }
    } else
    {
      RCU_INVARIANT (m_name.empty());
      RCU_INVARIANT (m_tree == 0);
      RCU_INVARIANT (m_form == 0);
      RCU_INVARIANT (m_manager == 0);
    }
  }

valid()

bool MD::Formula::valid

(

)

const

returns: whether the formula is valid guarantee: no-fail

Definition at line 148 of file Formula.cxx.

  {
    RCU_READ_INVARIANT (this);
    return !m_formula.empty() && m_ndim >= 0;
  }

value()

Double_t MD::Formula::value

(

std::size_t

data

)

const

returns: the result of evaluating the formula with the given index for the given data entry guarantee: strong failures: TTreeFormula errors requires: valid() requires: data < getNData()

Definition at line 200 of file Formula.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE_SOFT (valid ());
    RCU_REQUIRE_SOFT (data < ndata ());
 
    if (!m_read[data])
    {
      m_cache[data] = m_form->EvalInstance (data);
      m_read[data] = true;
    }
    return m_cache[data];
  }

Member Data Documentation

m_cache

std::vector<Double_t> MD::Formula::m_cache

mutableprivate

description: the cache of data entries

Definition at line 154 of file Formula.h.

m_entry

Long64_t MD::Formula::m_entry

mutableprivate

description: the last entry we read

Definition at line 146 of file Formula.h.

m_form

TTreeFormula* MD::Formula::m_form

private

description the formula used

Definition at line 133 of file Formula.h.

m_formula

std::string MD::Formula::m_formula

private

description: members directly corresponding to accessors

Definition at line 121 of file Formula.h.

m_manager

TTreeFormulaManager* MD::Formula::m_manager

private

description: the manager used

Definition at line 137 of file Formula.h.

m_name

std::string MD::Formula::m_name

private

description: the name we use for the formula

Definition at line 125 of file Formula.h.

m_ndata

Int_t MD::Formula::m_ndata

mutableprivate

description: the number of data entries

Definition at line 150 of file Formula.h.

m_ndim

int MD::Formula::m_ndim

private

description: the number of array dimensions we need to loop over, or -1 if we are in error

Definition at line 142 of file Formula.h.

m_read

std::vector<bool> MD::Formula::m_read

mutableprivate

description: whether we read the given data entry

Definition at line 158 of file Formula.h.

m_tree

TTree* MD::Formula::m_tree

private

description: the tree we are connected to

Definition at line 129 of file Formula.h.

---

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

• Formula.h
• Formula.cxx