Class to write C binary file. More...

#include <Mille.h>

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 50 of file Mille.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

buffer size for ints and floats

Enumerator
myBufferSize

Definition at line 70 of file Mille.h.

70{myBufferSize = 5000};

Mille::myBufferSize

@ myBufferSize

Definition Mille.h:70

◆ anonymous enum

anonymous enum

private

largest label allowed: 2^31 - 1

Enumerator
myMaxLabel

Definition at line 76 of file Mille.h.

76{myMaxLabel = (0xFFFFFFFF - (1 << 31))};

Mille::myMaxLabel

@ myMaxLabel

Definition Mille.h:76

Constructor & Destructor Documentation

◆ Mille()

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

Opens outFileName (by default as binary file).

author : Gero Flucke, University Hamburg, 2006 date : October 2006

Revision: 1.3

Date: 2007/04/16 17:47:38

(last update by

Author: flucke

)

Parameters

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

Definition at line 45 of file Mille.cc.

                                                                   : 
  myOutFile(outFileName, (asBinary ? (std::ios::binary | std::ios::out) : std::ios::out)),
  myAsBinary(asBinary), myWriteZero(writeZero), myBufferPos(-1), myHasSpecial(false)
{
  // Instead myBufferPos(-1), myHasSpecial(false) and the following two lines
  // we could call newSet() and kill()...
  myBufferInt[0]   = 0;
  myBufferFloat[0] = 0.;
 
  if (!myOutFile.is_open()) {
    std::cerr << "Mille::Mille: Could not open " << outFileName 
          << " as output file." << std::endl;
  }
}

◆ ~Mille()

Mille::~Mille ( )

Closes file.

Definition at line 62 of file Mille.cc.

{
  myOutFile.close();
}

Member Function Documentation

◆ checkBufferSize()

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 214 of file Mille.cc.

{
  if (myBufferPos + nLocal + nGlobal + 2 >= myBufferSize) {
    ++(myBufferInt[0]); // increase error count
    std::cerr << "Mille::checkBufferSize: Buffer too short (" 
          << myBufferSize << "),"
          << "\n need space for nLocal (" << nLocal<< ")"
          << "/nGlobal (" << nGlobal << ") local/global derivatives, " 
          << myBufferPos + 1 << " already stored!"
          << std::endl;
    return false;
  } else {
    return true;
  }
}

◆ end()

void Mille::end ( )

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

Definition at line 169 of file Mille.cc.

{
  if (myBufferPos > 0) { // only if anything stored...
    const int numWordsToWrite = (myBufferPos + 1)*2;
 
    if (myAsBinary) {
      myOutFile.write(reinterpret_cast<const char*>(&numWordsToWrite), 
              sizeof(numWordsToWrite));
      myOutFile.write(reinterpret_cast<char*>(myBufferFloat), 
              (myBufferPos+1) * sizeof(myBufferFloat[0]));
      myOutFile.write(reinterpret_cast<char*>(myBufferInt), 
              (myBufferPos+1) * sizeof(myBufferInt[0]));
    } else {
      myOutFile << numWordsToWrite << "\n";
      for (int i = 0; i < myBufferPos+1; ++i) {
    myOutFile << myBufferFloat[i] << " ";
      }
      myOutFile << "\n";
      
      for (int i = 0; i < myBufferPos+1; ++i) {
    myOutFile << myBufferInt[i] << " ";
      }
      myOutFile << "\n";
    }
  }
  myBufferPos = -1; // reset buffer for next set of derivatives
}

◆ kill()

void Mille::kill ( )

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

Definition at line 162 of file Mille.cc.

{
  myBufferPos = -1;
}

◆ mille()

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 78 of file Mille.cc.

{
  if (sigma <= 0.) return;
  if (myBufferPos == -1) this->newSet(); // start, e.g. new track
  if (!this->checkBufferSize(NLC, NGL)) return;
 
  // first store measurement
  ++myBufferPos;
  myBufferFloat[myBufferPos] = rMeas;
  myBufferInt  [myBufferPos] = 0;
 
  // store local derivatives and local 'lables' 1,...,NLC
  for (int i = 0; i < NLC; ++i) {
    if (derLc[i] || myWriteZero) { // by default store only non-zero derivatives
      ++myBufferPos;
      myBufferFloat[myBufferPos] = derLc[i]; // local derivatives
      myBufferInt  [myBufferPos] = i+1;      // index of local parameter
    }
  }
 
  // store uncertainty of measurement in between locals and globals
  ++myBufferPos;
  myBufferFloat[myBufferPos] = sigma;
  myBufferInt  [myBufferPos] = 0;
 
  // store global derivatives and their labels
  for (int i = 0; i < NGL; ++i) {
    if (derGl[i] || myWriteZero) { // by default store only non-zero derivatives
      if ((label[i] > 0 || myWriteZero) && label[i] <= myMaxLabel) { // and for valid labels
    ++myBufferPos;
    myBufferFloat[myBufferPos] = derGl[i]; // global derivatives
    myBufferInt  [myBufferPos] = label[i]; // index of global parameter
      } else {
    std::cerr << "Mille::mille: Invalid label " << label[i] 
          << " <= 0 or > " << myMaxLabel << std::endl; 
      }
    }
  }
}

◆ newSet()

void Mille::newSet ( )

private

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

Definition at line 199 of file Mille.cc.

{
  myBufferPos = 0;
  myHasSpecial = false;
  myBufferFloat[0] = 0.0;
  myBufferInt  [0] = 0;   // position 0 used as error counter
}

◆ 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 127 of file Mille.cc.

{
  if (nSpecial == 0) return;
  if (myBufferPos == -1) this->newSet(); // start, e.g. new track
  if (myHasSpecial) {
    std::cerr << "Mille::special: Special values already stored for this record."
          << std::endl; 
    return;
  }
  if (!this->checkBufferSize(nSpecial, 0)) return;
  myHasSpecial = true; // after newSet() (Note: MILLSP sets to buffer position...)
 
  //  myBufferFloat[.]  | myBufferInt[.]
  // ------------------------------------
  //      0.0           |      0
  //  -float(nSpecial)  |      0
  //  The above indicates special data, following are nSpecial floating and nSpecial integer data.
 
  ++myBufferPos; // zero pair
  myBufferFloat[myBufferPos] = 0.;
  myBufferInt  [myBufferPos] = 0;
 
  ++myBufferPos; // nSpecial and zero
  myBufferFloat[myBufferPos] = -nSpecial; // automatic conversion to float
  myBufferInt  [myBufferPos] = 0;
 
  for (int i = 0; i < nSpecial; ++i) {
    ++myBufferPos;
    myBufferFloat[myBufferPos] = floatings[i];
    myBufferInt  [myBufferPos] = integers[i];
  }
}

Member Data Documentation

◆ myAsBinary

bool Mille::myAsBinary

private

if false output as text

Definition at line 67 of file Mille.h.

◆ myBufferFloat

float Mille::myBufferFloat[myBufferSize]

private

to collect derivatives etc.

Definition at line 72 of file Mille.h.

◆ myBufferInt

int Mille::myBufferInt[myBufferSize]

private

to collect labels etc.

Definition at line 71 of file Mille.h.

◆ myBufferPos

int Mille::myBufferPos

private

position in buffer

Definition at line 73 of file Mille.h.

◆ myHasSpecial

bool Mille::myHasSpecial

private

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

Definition at line 74 of file Mille.h.

◆ myOutFile

std::ofstream Mille::myOutFile

private

C-binary for output.

Definition at line 66 of file Mille.h.

◆ myWriteZero

bool Mille::myWriteZero

private

if true also write out derivatives/labels ==0

Definition at line 68 of file Mille.h.

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

millepede/Mille.h
millepede/Mille.cc

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ Mille()

◆ ~Mille()

Member Function Documentation

◆ checkBufferSize()

◆ end()

◆ kill()

◆ mille()

◆ newSet()

◆ special()

Member Data Documentation

◆ myAsBinary

◆ myBufferFloat

◆ myBufferInt

◆ myBufferPos

◆ myHasSpecial

◆ myOutFile

◆ myWriteZero