helpers.h File Reference

#include <cassert>
#include <cstdio>
#include <cstring>
#include <functional>
#include <string>
#include "host.h"

Go to the source code of this file.

Classes
class	tesseract::TRand

Namespaces
	tesseract

Functions
void	chomp_string (char *str)
void	SkipNewline (FILE *file)
template<typename T >
void	Swap (T *p1, T *p2)
int	RoundUp (int n, int block_size)
template<typename T >
T	ClipToRange (const T &x, const T &lower_bound, const T &upper_bound)
template<typename T1 , typename T2 >
void	UpdateRange (const T1 &x, T2 *lower_bound, T2 *upper_bound)
template<typename T1 , typename T2 >
void	UpdateRange (const T1 &x_lo, const T1 &x_hi, T2 *lower_bound, T2 *upper_bound)
template<typename T >
void	IntersectRange (const T &lower1, const T &upper1, T *lower2, T *upper2)
int	Modulo (int a, int b)
int	DivRounded (int a, int b)
int	IntCastRounded (double x)
int	IntCastRounded (float x)
void	ReverseN (void *ptr, int num_bytes)
void	Reverse16 (void *ptr)
void	Reverse32 (void *ptr)
void	Reverse64 (void *ptr)

Function Documentation

chomp_string()

void chomp_string ( char *  str )

inline

Definition at line 83 of file helpers.h.

                                    {
  int last_index = static_cast<int>(strlen(str)) - 1;
  while (last_index >= 0 &&
         (str[last_index] == '\n' || str[last_index] == '\r')) {
    str[last_index--] = '\0';
  }
}

ClipToRange()

template<typename T >

T ClipToRange ( const T &  x, const T &  lower_bound, const T &  upper_bound  )

inline

Definition at line 111 of file helpers.h.

                                                                             {
  if (x < lower_bound)
    return lower_bound;
  if (x > upper_bound)
    return upper_bound;
  return x;
}

DivRounded()

int DivRounded ( int  a, int  b  )

inline

Definition at line 162 of file helpers.h.

                                    {
  if (b < 0) return -DivRounded(a, -b);
  return a >= 0 ? (a + b / 2) / b : (a - b / 2) / b;
}

IntCastRounded() [1/2]

int IntCastRounded ( double  x )

inline

Definition at line 168 of file helpers.h.

                                    {
  return x >= 0.0 ? static_cast<int>(x + 0.5) : -static_cast<int>(-x + 0.5);
}

IntCastRounded() [2/2]

int IntCastRounded ( float  x )

inline

Definition at line 173 of file helpers.h.

                                   {
  return x >= 0.0f ? static_cast<int>(x + 0.5f) : -static_cast<int>(-x + 0.5f);
}

IntersectRange()

template<typename T >

void IntersectRange ( const T &  lower1, const T &  upper1, T *  lower2, T *  upper2  )

inline

Definition at line 142 of file helpers.h.

                                                 {
  if (lower1 > *lower2)
    *lower2 = lower1;
  if (upper1 < *upper2)
    *upper2 = upper1;
}

Modulo()

int Modulo ( int  a, int  b  )

inline

Definition at line 153 of file helpers.h.

                                {
  return (a % b + b) % b;
}

Reverse16()

void Reverse16 ( void *  ptr )

inline

Definition at line 190 of file helpers.h.

                                 {
  ReverseN(ptr, 2);
}

Reverse32()

void Reverse32 ( void *  ptr )

inline

Definition at line 195 of file helpers.h.

                                 {
  ReverseN(ptr, 4);
}

Reverse64()

void Reverse64 ( void *  ptr )

inline

Definition at line 200 of file helpers.h.

                                 {
  ReverseN(ptr, 8);
}

ReverseN()

void ReverseN ( void *  ptr, int  num_bytes  )

inline

Definition at line 178 of file helpers.h.

                                               {
  assert(num_bytes == 1 || num_bytes == 2 || num_bytes == 4 || num_bytes == 8);
  char* cptr = static_cast<char*>(ptr);
  int halfsize = num_bytes / 2;
  for (int i = 0; i < halfsize; ++i) {
    char tmp = cptr[i];
    cptr[i] = cptr[num_bytes - 1 - i];
    cptr[num_bytes - 1 - i] = tmp;
  }
}

RoundUp()

int RoundUp ( int  n, int  block_size  )

inline

Definition at line 105 of file helpers.h.

                                          {
  return block_size * ((n + block_size - 1) / block_size);
}

SkipNewline()

void SkipNewline ( FILE *  file )

inline

Definition at line 92 of file helpers.h.

                                    {
  if (fgetc(file) != '\n') fseek(file, -1, SEEK_CUR);
}

Swap()

template<typename T >

void Swap ( T *  p1, T *  p2  )

inline

Definition at line 98 of file helpers.h.

                                                    {
  T tmp(*p2);
  *p2 = *p1;
  *p1 = tmp;
}

UpdateRange() [1/2]

template<typename T1 , typename T2 >

void UpdateRange ( const T1 &  x, T2 *  lower_bound, T2 *  upper_bound  )

inline

Definition at line 121 of file helpers.h.

                                                                       {
  if (x < *lower_bound)
    *lower_bound = x;
  if (x > *upper_bound)
    *upper_bound = x;
}

UpdateRange() [2/2]

template<typename T1 , typename T2 >

void UpdateRange ( const T1 &  x_lo, const T1 &  x_hi, T2 *  lower_bound, T2 *  upper_bound  )

inline

Definition at line 130 of file helpers.h.

                                                          {
  if (x_lo < *lower_bound)
    *lower_bound = x_lo;
  if (x_hi > *upper_bound)
    *upper_bound = x_hi;
}