A named, vectorised generalisation of an event weight. More...

#include <Weights.h>

Public Member Functions
Constructors
	Weights (const Weights &other)

	Weights (double value)
	Convenience auto-constructor from a single double, since that's the commonest use case.

	Weights (const std::vector< std::pair< std::string, double > > &keys_values)
	Constructor from a vector of key/value pairs.

	Weights (const std::vector< std::string > &keys, const std::vector< double > &values)
	Constructor from vectors of keys and values.

	Weights (const std::vector< std::string > &keys, double value=0.0)
	Constructor from vectors of keys and a single value, defaulting to 0.0.

Arithmetic operators as members
Weights &	operator+= (const Weights &toAdd)
	Add another weights to this.

Weights &	operator-= (const Weights &toSubtract)
	Subtract another weights from this.

Weights &	operator*= (const Weights &toMultiplyBy)
	Multiply by another weights.

Weights &	operator/= (const Weights &toDivideBy)
	Divide by another weights.

Weights &	operator*= (double toMultiplyBy)
	Multiply by a double.

Weights &	operator/= (double toDivideBy)
	Divide by a double.

Weights	operator- () const

Comparison operators
bool	operator== (const Weights &other) const
	Equals.

bool	operator!= (const Weights &other) const
	Not equals.

Accessors
Todo: Sorted iterators of pair<std::string, double>
typedef std::map< std::string, double >::iterator	iterator

typedef std::map< std::string, double >::const_iterator	const_iterator

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

double &	operator[] (const std::string &key)

const double &	operator[] (const std::string &key) const

double &	operator[] (size_t index)

const double &	operator[] (size_t index) const

unsigned int	size () const
	Number of weights keys.

std::vector< std::string >	keys () const
	Sorted list of weight keys.

std::vector< double >	values () const
	List of weight values, in the order of the sorted keys.

Detailed Description

A named, vectorised generalisation of an event weight.

Todo:

Accept general Boost.Ranges as constructor args... but start with literal arrays for convenience

Autogenerate numerical names if not given

Definition at line 22 of file Weights.h.

Member Typedef Documentation

◆ const_iterator

typedef std::map<std::string,double>::const_iterator YODA::Weights::const_iterator

Definition at line 72 of file Weights.h.

◆ iterator

typedef std::map<std::string,double>::iterator YODA::Weights::iterator

Definition at line 71 of file Weights.h.

Constructor & Destructor Documentation

◆ Weights() [1/5]

YODA::Weights::Weights ( const Weights & other )

inline

Definition at line 28 of file Weights.h.

29 : _values(other._values)

30 { }

◆ Weights() [2/5]

YODA::Weights::Weights ( double value )

inline

Convenience auto-constructor from a single double, since that's the commonest use case.

Definition at line 33 of file Weights.h.

                          {
      _values["0"] = value;
    }

◆ Weights() [3/5]

YODA::Weights::Weights ( const std::vector< std::pair< std::string, double > > & keys_values )

inline

Constructor from a vector of key/value pairs.

Definition at line 38 of file Weights.h.

                                                                       {
      for (std::vector<std::pair<std::string, double> >::const_iterator i = keys_values.begin(); i != keys_values.end(); ++i) {
        _values[i->first] = i->second;
      }
    }

◆ Weights() [4/5]

YODA::Weights::Weights	(	const std::vector< std::string > &	keys,
		const std::vector< double > &	values
	)

inline

Constructor from vectors of keys and values.

Definition at line 45 of file Weights.h.

                                                                               {
      if (keys.size() != values.size()) {
        throw WeightError("Mismatch in lengths of keys and values vectors in Weights constructor");
      }
      for (size_t i = 0; i < keys.size(); ++i) {
        _values[keys[i]] = values[i];
      }
    }

References keys(), and values().

◆ Weights() [5/5]

YODA::Weights::Weights	(	const std::vector< std::string > &	keys,
		double	value = `0.0`
	)

inline

Constructor from vectors of keys and a single value, defaulting to 0.0.

Definition at line 55 of file Weights.h.

                                                                {
      for (std::vector<std::string>::const_iterator i = keys.begin(); i != keys.end(); ++i) {
        _values[*i] = value;
      }
    }

References keys().

Member Function Documentation

◆ begin() [1/2]

iterator YODA::Weights::begin ( )

inline

Definition at line 73 of file Weights.h.

73{ return _values.begin(); }

Referenced by keys(), YODA::operator<<(), and values().

◆ begin() [2/2]

const_iterator YODA::Weights::begin ( ) const

inline

Definition at line 74 of file Weights.h.

74{ return _values.begin(); }

◆ end() [1/2]

iterator YODA::Weights::end ( )

inline

Definition at line 75 of file Weights.h.

75{ return _values.end(); }

Referenced by keys(), YODA::operator<<(), and values().

◆ end() [2/2]

const_iterator YODA::Weights::end ( ) const

inline

Definition at line 76 of file Weights.h.

76{ return _values.end(); }

◆ keys()

std::vector< std::string > YODA::Weights::keys ( ) const

inline

Sorted list of weight keys.

Definition at line 111 of file Weights.h.

                                      {
      std::vector<std::string> rtn;
      rtn.reserve(size());
      for (const_iterator i = begin(); i != end(); ++i) {
        rtn.push_back(i->first);
      }
      return rtn;
    }

References begin(), end(), and size().

Referenced by operator*=(), operator*=(), operator+=(), operator-=(), YODA::operator/(), operator/=(), operator/=(), operator[](), operator[](), Weights(), and Weights().

◆ operator!=()

bool YODA::Weights::operator!= ( const Weights & other ) const

inline

Not equals.

Definition at line 220 of file Weights.h.

                                                  {
      return !(*this == other);
    }

◆ operator*=() [1/2]

Weights & YODA::Weights::operator*= ( const Weights & toMultiplyBy )

inline

Multiply by another weights.

Definition at line 161 of file Weights.h.

                                                       {
      if (keys().empty()) _initToMatch(toMultiplyBy);
      if (keys() != toMultiplyBy.keys()) {
        throw WeightError("Mismatch in args to Weights *= operator");
      }
      for (size_t i = 0; i < size(); ++i) {
        _values[keys()[i]] *= toMultiplyBy[keys()[i]];
      }
      return *this;
    }

References keys(), and size().

◆ operator*=() [2/2]

Weights & YODA::Weights::operator*= ( double toMultiplyBy )

inline

Multiply by a double.

Definition at line 185 of file Weights.h.

                                               {
      for (size_t i = 0; i < size(); ++i) {
        _values[keys()[i]] *= toMultiplyBy;
      }
      return *this;
    }

References keys(), and size().

◆ operator+=()

Weights & YODA::Weights::operator+= ( const Weights & toAdd )

inline

Add another weights to this.

Definition at line 137 of file Weights.h.

                                                {
      if (keys().empty()) _initToMatch(toAdd);
      if (keys() != toAdd.keys()) {
        throw WeightError("Mismatch in args to Weights += operator");
      }
      for (size_t i = 0; i < size(); ++i) {
        _values[keys()[i]] += toAdd[keys()[i]];
      }
      return *this;
    }

References keys(), and size().

◆ operator-()

Weights YODA::Weights::operator- ( ) const

inline

Negate

Todo:: Can/should this modify itself and return a reference?

Definition at line 202 of file Weights.h.

                                {
      Weights rtn = *this;
      rtn *= -1;
      return rtn;
    }

◆ operator-=()

Weights & YODA::Weights::operator-= ( const Weights & toSubtract )

inline

Subtract another weights from this.

Definition at line 149 of file Weights.h.

                                                     {
      if (keys().empty()) _initToMatch(toSubtract);
      if (keys() != toSubtract.keys()) {
        throw WeightError("Mismatch in args to Weights -= operator");
      }
      for (size_t i = 0; i < size(); ++i) {
        _values[keys()[i]] -= toSubtract[keys()[i]];
      }
      return *this;
    }

References keys(), and size().

◆ operator/=() [1/2]

Weights & YODA::Weights::operator/= ( const Weights & toDivideBy )

inline

Divide by another weights.

Definition at line 173 of file Weights.h.

                                                     {
      if (keys().empty()) _initToMatch(toDivideBy);
      if (keys() != toDivideBy.keys()) {
        throw WeightError("Mismatch in args to Weights /= operator");
      }
      for (size_t i = 0; i < size(); ++i) {
        _values[keys()[i]] /= toDivideBy[keys()[i]];
      }
      return *this;
    }

References keys(), and size().

◆ operator/=() [2/2]

Weights & YODA::Weights::operator/= ( double toDivideBy )

inline

Divide by a double.

Definition at line 193 of file Weights.h.

                                             {
      for (size_t i = 0; i < size(); ++i) {
        _values[keys()[i]] /= toDivideBy;
      }
      return *this;
    }

References keys(), and size().

◆ operator==()

bool YODA::Weights::operator== ( const Weights & other ) const

inline

Equals.

Definition at line 215 of file Weights.h.

                                                  {
      return this->_values == other._values;
    }

◆ operator[]() [1/4]

double & YODA::Weights::operator[] ( const std::string & key )

inline

Definition at line 78 of file Weights.h.

                                               {
      if (_values.find(key) == _values.end()) {
        throw WeightError("No weight found with supplied name");
      }
      return _values[key];
    }

◆ operator[]() [2/4]

const double & YODA::Weights::operator[] ( const std::string & key ) const

inline

Definition at line 84 of file Weights.h.

                                                           {
      const_iterator rtn = _values.find(key);
      if (rtn == _values.end()) {
        throw WeightError("No weight found with supplied name");
      }
      return rtn->second;
    }

◆ operator[]() [3/4]

double & YODA::Weights::operator[] ( size_t index )

inline

Definition at line 92 of file Weights.h.

                                       {
      if (index >= size()) {
        throw WeightError("Requested weight index is larger than the weights collection");
      }
      return _values[keys()[index]];
    }

References keys(), and size().

◆ operator[]() [4/4]

const double & YODA::Weights::operator[] ( size_t index ) const

inline

Definition at line 98 of file Weights.h.

                                                   {
      if (index >= size()) {
        throw WeightError("Requested weight index is larger than the weights collection");
      }
      return _values.find(keys()[index])->second;
    }

References keys(), and size().

◆ size()

unsigned int YODA::Weights::size ( ) const

inline

Number of weights keys.

Definition at line 106 of file Weights.h.

                              {
      return _values.size();
    }

Referenced by keys(), operator*=(), operator*=(), operator+=(), operator-=(), operator/=(), operator/=(), operator[](), operator[](), and values().

◆ values()

std::vector< double > YODA::Weights::values ( ) const

inline

List of weight values, in the order of the sorted keys.

Definition at line 121 of file Weights.h.

                                     {
      std::vector<double> rtn;
      rtn.reserve(size());
      for (const_iterator i = begin(); i != end(); ++i) {
        rtn.push_back(i->second);
      }
      return rtn;
    }

References begin(), end(), and size().

Referenced by Weights().

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

include/YODA/Weights.h

Public Member Functions

Accessors

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ Weights() [1/5]

◆ Weights() [2/5]

◆ Weights() [3/5]

◆ Weights() [4/5]

◆ Weights() [5/5]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ keys()

◆ operator!=()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator==()

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ size()

◆ values()