BOL::UsefulStuff Class Reference

#include <UsefulStuff.hpp>

Detailed Description

Definition at line 25 of file UsefulStuff.hpp.

Static Public Member Functions
static bool	doublesCloseEnough (double const firstDouble, double const secondDouble, double maximumDifference)
static bool	fileExists (std::string const &fileName)
static double	flatRandomDouble (double const lowerLimit, double const upperLimit)
static int	plusOrMinusOne ()
static void	runSystemCommand (std::string const &systemCommand)
static int	zeroOrOne ()

Static Public Attributes
static std::string const	nanString
static double const	notANumber
static double const	twicePi

Static Private Member Functions
static void	ensureRandomSeedIsSet ()

Static Private Attributes
static bool	randomSeedNotYetSet

Member Function Documentation

doublesCloseEnough()

bool BOL::UsefulStuff::doublesCloseEnough ( double const  firstDouble, double const  secondDouble, double  maximumDifference  )

inlinestatic

Definition at line 69 of file UsefulStuff.hpp.

  {
    return ( abs( maximumDifference ) >= abs( firstDouble - secondDouble ) );
  }

ensureRandomSeedIsSet()

void BOL::UsefulStuff::ensureRandomSeedIsSet ( )

inlinestaticprivate

time_t currentTime = time( NULL ); srand( currentTime ); std::cout << std::endl << "currentTime = " << currentTime;

Definition at line 114 of file UsefulStuff.hpp.

  {
    if( randomSeedNotYetSet )
    {
      // debugging:
      srand( time( NULL ) );
      randomSeedNotYetSet = false;
    }
  }

fileExists()

bool BOL::UsefulStuff::fileExists ( std::string const &  fileName )

inlinestatic

Definition at line 129 of file UsefulStuff.hpp.

  {
    std::ifstream fileStream( fileName.c_str() );
    if( fileStream.good() )
    {
      fileStream.close();
      return true;
    }
    else
    {
      return false;
    }
  }

flatRandomDouble()

double BOL::UsefulStuff::flatRandomDouble ( double const  lowerLimit, double const  upperLimit  )

inlinestatic

Definition at line 79 of file UsefulStuff.hpp.

  {
    ensureRandomSeedIsSet();
    return ( lowerLimit + ( (double)(rand()) / (double)RAND_MAX )
                          * ( upperLimit - lowerLimit ) );
  }

plusOrMinusOne()

int BOL::UsefulStuff::plusOrMinusOne ( )

inlinestatic

Definition at line 100 of file UsefulStuff.hpp.

  {
    if( 0 == zeroOrOne() )
    {
      return -1;
    }
    else
    {
      return 1;
    }
  }

runSystemCommand()

void BOL::UsefulStuff::runSystemCommand ( std::string const &  systemCommand )

inlinestatic

Definition at line 145 of file UsefulStuff.hpp.

  {
    int systemReturn( system( systemCommand.c_str() ) );
    if( -1 == systemReturn )
    {
      throw std::runtime_error( "system( \"" +  systemCommand
                                + "\" ) returned -1" );
    }
  }

zeroOrOne()

int BOL::UsefulStuff::zeroOrOne ( )

inlinestatic

Definition at line 92 of file UsefulStuff.hpp.

  {
    ensureRandomSeedIsSet();
    return ( (rand()) % 2 );
  }

Member Data Documentation

nanString

std::string const BOL::UsefulStuff::nanString

static

Definition at line 29 of file UsefulStuff.hpp.

notANumber

double const BOL::UsefulStuff::notANumber

static

Definition at line 28 of file UsefulStuff.hpp.

randomSeedNotYetSet

bool BOL::UsefulStuff::randomSeedNotYetSet

staticprivate

Definition at line 60 of file UsefulStuff.hpp.

twicePi

double const BOL::UsefulStuff::twicePi

static

Definition at line 30 of file UsefulStuff.hpp.

---

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

• UsefulStuff.hpp
• UsefulStuff.cpp