Mille Class Reference

Class to write C binary file. More...

#include <Mille.h>

List of all members.

Public Member Functions
	Mille (const char *outFileName, bool asBinary=true, bool writeZero=false)
	Opens outFileName (by default as binary file).
	~Mille ()
	Closes file.
void	mille (int NLC, const float *derLc, int NGL, const float *derGl, const int *label, float rMeas, float sigma)
	Add measurement to buffer.
void	special (int nSpecial, const float *floatings, const int *integers)
	Add special data to buffer.
void	kill ()
	Reset buffers, i.e. kill derivatives accumulated for current set.
void	end ()
	Write buffer (set of derivatives with same local parameters) to file.

Private Types
enum	{ myBufferSize = 5000 }
	buffer size for ints and floats More...
enum	{ myMaxLabel = (0xFFFFFFFF - (1 << 31)) }
	largest label allowed: 2^31 - 1 More...

Private Member Functions
void	newSet ()
	Initialize for new set of locals, e.g. new track.
bool	checkBufferSize (int nLocal, int nGlobal)
	Enough space for next nLocal + nGlobal derivatives incl. measurement?

Private Attributes
std::ofstream	myOutFile
	C-binary for output.
bool	myAsBinary
	if false output as text
bool	myWriteZero
int	myBufferInt [myBufferSize]
	to collect labels etc.
float	myBufferFloat [myBufferSize]
	to collect derivatives etc.
int	myBufferPos
	position in buffer
bool	myHasSpecial

---

Detailed Description

Class to write C binary file.

Class to write a C binary (cf. below) file of a given name and to fill it with information used as input to pede. Use its member functions mille(), special(), kill() and end() as you would use the fortran MILLE and its entry points MILLSP, KILLE and ENDLE.

For debugging purposes constructor flags enable switching to text output and/or to write also derivatives and labels which are ==0. But note that pede will not be able to read text output and has not been tested with derivatives/labels ==0.

Author:

: Gero Flucke date : October 2006

Revision:

1.3

Date:

2007/04/16 17:47:38

(last update by

Author:

flucke

)

Definition at line 28 of file Mille.h.

---

Member Enumeration Documentation

anonymous enum

private

buffer size for ints and floats

Enumerator:

myBufferSize

Definition at line 48 of file Mille.h.

anonymous enum

private

largest label allowed: 2^31 - 1

Enumerator:

myMaxLabel

Definition at line 54 of file Mille.h.

---

Constructor & Destructor Documentation

Mille::Mille	(	const char *	outFileName,
		bool	asBinary = true,
		bool	writeZero = false
	)

Opens outFileName (by default as binary file).

Parameters:

[in]	outFileName	file name
[in]	asBinary	flag for binary
[in]	writeZero	flag for keeping of zeros

Definition at line 25 of file Mille.cc.

References myBufferFloat, myBufferInt, and myOutFile.

Mille::~Mille

(

)

Closes file.

Definition at line 42 of file Mille.cc.

References myOutFile.

---

Member Function/Subroutine Documentation

bool Mille::checkBufferSize ( int  nLocal, int  nGlobal  )

private

Enough space for next nLocal + nGlobal derivatives incl. measurement?

Parameters:

[in]	nLocal	number of local derivatives
[in]	nGlobal	number of global derivatives

Returns:

true if sufficient space available (else false)

Definition at line 194 of file Mille.cc.

References myBufferInt, myBufferPos, and myBufferSize.

Referenced by mille(), and special().

void Mille::end

(

)

Write buffer (set of derivatives with same local parameters) to file.

Definition at line 149 of file Mille.cc.

References myAsBinary, myBufferFloat, myBufferInt, myBufferPos, and myOutFile.

void Mille::kill

(

)

Reset buffers, i.e. kill derivatives accumulated for current set.

Definition at line 142 of file Mille.cc.

References myBufferPos.

void Mille::mille	(	int	NLC,
		const float *	derLc,
		int	NGL,
		const float *	derGl,
		const int *	label,
		float	rMeas,
		float	sigma
	)

Add measurement to buffer.

Parameters:

[in]	NLC	number of local derivatives
[in]	derLc	local derivatives
[in]	NGL	number of global derivatives
[in]	derGl	global derivatives
[in]	label	global labels
[in]	rMeas	measurement (residuum)
[in]	sigma	error

Definition at line 58 of file Mille.cc.

References checkBufferSize(), myBufferFloat, myBufferInt, myBufferPos, myMaxLabel, myWriteZero, and newSet().

void Mille::newSet ( )

private

Initialize for new set of locals, e.g. new track.

Definition at line 179 of file Mille.cc.

References myBufferFloat, myBufferInt, myBufferPos, and myHasSpecial.

Referenced by mille(), and special().

void Mille::special	(	int	nSpecial,
		const float *	floatings,
		const int *	integers
	)

Add special data to buffer.

Parameters:

[in]	nSpecial	number of floats/ints
[in]	floatings	floats
[in]	integers	ints

Definition at line 107 of file Mille.cc.

References checkBufferSize(), myBufferFloat, myBufferInt, myBufferPos, myHasSpecial, and newSet().

---

Member Data Documentation

bool Mille::myAsBinary

private

if false output as text

Definition at line 45 of file Mille.h.

Referenced by end().

float Mille::myBufferFloat[myBufferSize]

private

to collect derivatives etc.

Definition at line 50 of file Mille.h.

Referenced by end(), Mille(), mille(), newSet(), and special().

int Mille::myBufferInt[myBufferSize]

private

to collect labels etc.

Definition at line 49 of file Mille.h.

Referenced by checkBufferSize(), end(), Mille(), mille(), newSet(), and special().

int Mille::myBufferPos

private

position in buffer

Definition at line 51 of file Mille.h.

Referenced by checkBufferSize(), end(), kill(), mille(), newSet(), and special().

bool Mille::myHasSpecial

private

if true, special(..) already called for this record

Definition at line 52 of file Mille.h.

Referenced by newSet(), and special().

std::ofstream Mille::myOutFile

private

C-binary for output.

Definition at line 44 of file Mille.h.

Referenced by end(), Mille(), and ~Mille().

bool Mille::myWriteZero

private

if true also write out derivatives/labels ==0

Definition at line 46 of file Mille.h.

Referenced by mille().

---

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

• Mille.h
• Mille.cc