gamma_params.hpp File Reference

#include <ostream>

Go to the source code of this file.

Classes
class	GammaParams
	Represents a yield and uncertainty obtained by counting weighted events. More...

Functions
GammaParams	operator+ (GammaParams gp1, GammaParams gp2)
	Add two GammaParams. More...
GammaParams	operator* (double scale, GammaParams gp)
	Scale/multiply a GammaParams by a constant on the left. More...
GammaParams	operator* (GammaParams gp, double scale)
	Scale/multiply a GammaParams by a constant on the right. More...
std::ostream &	operator<< (std::ostream &stream, const GammaParams &gp)
	Print GammaParams to output stream. More...

Function Documentation

GammaParams operator*	(	double	scale,
		GammaParams	gp
	)

Scale/multiply a GammaParams by a constant on the left.

Parameters

[in]	scale	Amount by which to scale gp
[in]	gp	GammaParams to be scaled

Returns

Scaled copy of gp

See also

GammaParams::operator*=()

Definition at line 222 of file gamma_params.cpp.

GammaParams operator*	(	GammaParams	gp,
		double	scale
	)

Scale/multiply a GammaParams by a constant on the right.

Parameters

[in]	gp	GammaParams to be scaled
[in]	scale	Amount by which to scale gp

Returns

Scaled copy of gp

See also

GammaParams::operator*=()

Definition at line 236 of file gamma_params.cpp.

GammaParams operator+	(	GammaParams	gp1,
		GammaParams	gp2
	)

Add two GammaParams.

Parameters

[in]	gp1	Left-hand addend
[in]	gp2	Right-hand addend

Returns

Regerence to *this

See also

GammaParams::operator+=()

Definition at line 208 of file gamma_params.cpp.

std::ostream& operator<<	(	std::ostream &	stream,
		const GammaParams &	gp
	)

Print GammaParams to output stream.

Parameters

[in,out]	stream	Output stream to print to
[in]	gp	GammaParams to print

Returns

Reference to stream

Definition at line 248 of file gamma_params.cpp.

References GammaParams::CorrectedUncertainty(), GammaParams::NEffective(), GammaParams::Weight(), and GammaParams::Yield().