Weights Class Reference

#include <Weights.h>

Inheritance diagram for Weights:

Public Member Functions
	Weights ()
	Weights (double weight)
int	numWeights () const
const std::vector< double > &	getWeightsVector ()
void	printWeight (std::ostream &os=std::cout, int endline=1) const
double	getWeight (int i=0) const
void	setWeight (int i, double w)
void	setWeight (double w)
void	addWeight (const double &weight)
virtual	~Weights ()

Protected Attributes
std::vector< double >	_weights

Detailed Description

HyperPlot, Author: Sam Harnew, sam.h.nosp@m.arne.nosp@m.w@gma.nosp@m.il.c.nosp@m.om , Date: Dec 2015

Holds a vector of weights that is associtated to a HyperPoint via inheritance (sometimes useful to have more than one for systematic studies)

Definition at line 23 of file Weights.h.

Constructor & Destructor Documentation

Weights() [1/2]

Weights::Weights

(

)

Empty constructor

Definition at line 5 of file Weights.cpp.

{

}

Weights() [2/2]

Weights::Weights

(

double

weight

)

Construct instance with a single weight (probably the most used scenario)

Definition at line 12 of file Weights.cpp.

                              :
  _weights(1, weight)
{

}

~Weights()

Weights::~Weights ( )

virtual

Definition at line 75 of file Weights.cpp.

                 {

}

Member Function Documentation

addWeight()

void Weights::addWeight

(

const double &

weight

)

Add weight to the end of the weight vector

Definition at line 71 of file Weights.cpp.

                                           {
  _weights.push_back(weight);
}

getWeight()

double Weights::getWeight

(

int

i = 0

)

const

Get weight i. If no weights exist just return 1.0.

Definition at line 40 of file Weights.cpp.

                                    {
  if ( numWeights() == 0 && i == 0) return 1.0; //If no weights, assume it's unweighted i.e. w = 1.0
  if (i >= numWeights()){
    ERROR_LOG << "There are not this many weights avaliable. Returning weight 0 - may crash if this doesn't exist";
    return _weights.at(0);
  }
  return _weights.at(i);
}

getWeightsVector()

const std::vector<double>& Weights::getWeightsVector ( )

inline

return the vector of weights

Definition at line 36 of file Weights.h.

numWeights()

int Weights::numWeights

(

)

const

How many weights have been stored

Definition at line 20 of file Weights.cpp.

                             {
  return _weights.size();
}

printWeight()

void Weights::printWeight	(	std::ostream &	os = std::cout,
		int	endline = 1
	)		const

print weights to specified ostream (default is cout)

Definition at line 26 of file Weights.cpp.

                                                          {
  if (numWeights() != 0){
    os << "weights = ";
    for (int i = 0; i < numWeights(); i++) {
      os << getWeight(i);
      if (i != (numWeights() -1)) os << ", ";
    }
  }
  if(endline == 1) os << std::endl;

}

setWeight() [1/2]

void Weights::setWeight	(	int	i,
		double	w
	)

Set weight i to specified value - if this weight doesn't yet exist, keep adding weights of 1.0 until it does

Definition at line 52 of file Weights.cpp.

                                      { 

  if (i >= numWeights()) {
    addWeight(1.0); 
    setWeight(i, w);
  }
  else{
    _weights.at(i) = w; 
  }
}

setWeight() [2/2]

void Weights::setWeight

(

double

w

)

Set weight i=0 to desired value

Definition at line 65 of file Weights.cpp.

                               { 
  setWeight(0, w);
}

Member Data Documentation

_weights

std::vector<double> Weights::_weights

protected

vector of weights

Definition at line 27 of file Weights.h.

---

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

• Mint/Weights.h
• src/Mojito/Chi2Test/Weights.cpp