YScanner::Table Struct Reference

A table of equidistant entries. More...

#include <YScanner.h>

Public Member Functions
	Table ()
	Default constructor.
void	clear ()
	Clear the content entirely.
void	set (double X0, double Step)
	Sets the first x and the step, and clears the entries.
void	set (const Table &T)
	Sets the first x and the step, and clears the entries.
double	getX (int i) const
	Returns x for a given index.
double	getXmin () const
	Returns x of the first entry.
double	getXmax () const
	Returns x of the last entry.
int	getIndex (double x) const
	Returns index.
double	getY (int i) const
	Returns y for a given index.

Public Attributes
double	x0 = 0
	x of first entry
double	step = 0
	step size
std::vector< TableEntry >	entries
	table entries

Detailed Description

A table of equidistant entries.

Definition at line 118 of file YScanner.h.

Constructor & Destructor Documentation

Table()

Table ( )

inline

Default constructor.

Definition at line 126 of file YScanner.h.

        {}

Member Function Documentation

clear()

void clear ( )

inline

Clear the content entirely.

Definition at line 511 of file YScanner.h.

    {
      x0 = 0;
      step = 0;
      entries.clear();
    }

getIndex()

int getIndex ( double  x ) const

inline

Returns index.

Returns

index (note: the range is not limited to the range of entries)

Definition at line 538 of file YScanner.h.

{return lround((x - x0) / step);}

getX()

double getX ( int  i ) const

inline

Returns x for a given index.

Returns

x

Definition at line 532 of file YScanner.h.

{return x0 + step * i;}

getXmax()

double getXmax ( ) const

inline

Returns x of the last entry.

Returns

maximal x

Definition at line 536 of file YScanner.h.

{return x0 + step * (entries.size() - 1);}

getXmin()

double getXmin ( ) const

inline

Returns x of the first entry.

Returns

minimal x

Definition at line 534 of file YScanner.h.

{return x0;}

getY()

double getY ( int  i ) const

inline

Returns y for a given index.

Returns

y or 0 if index is out of range

Definition at line 540 of file YScanner.h.

    {
      unsigned k = i;
      if (k >= entries.size()) return 0;
      return entries[k].y;
    }

set() [1/2]

void set ( const Table &  T )

inline

Sets the first x and the step, and clears the entries.

Parameters

T

the table

Definition at line 525 of file YScanner.h.

    {
      x0 = T.x0;
      step = T.step;
      entries.clear();
    }

set() [2/2]

void set ( double  X0, double  Step  )

inline

Sets the first x and the step, and clears the entries.

Parameters

X0	x of the first entry
Step	step size

Definition at line 518 of file YScanner.h.

    {
      x0 = X0;
      step = Step;
      entries.clear();
    }

Member Data Documentation

entries

std::vector<TableEntry> entries

table entries

Definition at line 121 of file YScanner.h.

step

double step = 0

step size

Definition at line 120 of file YScanner.h.

x0

double x0 = 0

x of first entry

Definition at line 119 of file YScanner.h.

---

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

• top/reconstruction_cpp/include/YScanner.h