TestManagerClass< T > Class Template Reference

Test manager class. More...

Classes
struct	FailureInfo_t
	Data structure to document failure of a single action. More...

Public Types
typedef T	Data_t
typedef TestManagerClass< Data_t >	This_t
typedef std::vector< Data_t >	Vector_t
typedef lar::sparse_vector< Data_t >	SparseVector_t
typedef actions::BaseAction< Data_t >	Action_t

Public Member Functions
	TestManagerClass (std::ostream &output_stream=std::cout)
	Constructor, specify an output stream. More...
size_t	current_vector_size () const
	Returns the current size of the STL vector. More...
bool	validate () const
	Checks if the sparse vector is valid. More...
bool	match () const
unsigned int	check ()
void	run (const Action_t &action)
unsigned int	perform (const Action_t &action, bool autoCorrect=true)
	Perform the specified action and evaluate the result. More...
int	quiet (int nq=0)
unsigned int	operator() (const Action_t &action)
void	recover ()
	Set the sparse vector as a copy of the vector (lossy!) More...
void	mirror ()
	Set the vector as a copy of the sparse vector. More...
int	summary () const
	Print a summary of the failures. More...

Public Attributes
Vector_t	v {}
	vector to operate on More...
SparseVector_t	sv {}
	sparse vector to operate on More...
unsigned int	nAction {0}
	number of actions taken so far More...
unsigned int	nErrors {0}
	number of errors accumulated More...
std::vector< FailureInfo_t >	failures
	documentation of the failures More...
int	quietness {0}
	verbosity level (larger is less verbose) More...
std::ostream &	out
	output stream More...

Detailed Description

template<typename T>
class TestManagerClass< T >

Test manager class.

Definition at line 81 of file sparse_vector_test.cc.

Member Typedef Documentation

template<typename T>

typedef actions::BaseAction<Data_t> TestManagerClass< T >::Action_t

Definition at line 87 of file sparse_vector_test.cc.

template<typename T>

typedef T TestManagerClass< T >::Data_t

Definition at line 83 of file sparse_vector_test.cc.

template<typename T>

typedef lar::sparse_vector<Data_t> TestManagerClass< T >::SparseVector_t

Definition at line 86 of file sparse_vector_test.cc.

template<typename T>

typedef TestManagerClass<Data_t> TestManagerClass< T >::This_t

Definition at line 84 of file sparse_vector_test.cc.

template<typename T>

typedef std::vector<Data_t> TestManagerClass< T >::Vector_t

Definition at line 85 of file sparse_vector_test.cc.

Constructor & Destructor Documentation

template<typename T>

TestManagerClass< T >::TestManagerClass ( std::ostream &  output_stream = std::cout )

inline

Constructor, specify an output stream.

Definition at line 114 of file sparse_vector_test.cc.

                                                       : out(output_stream)
    {}

Member Function Documentation

template<typename T>

unsigned int TestManagerClass< T >::check ( )

inline

Definition at line 164 of file sparse_vector_test.cc.

    {
      unsigned int local_errors = 0;
      if (!validate()) ++local_errors;
      if (!match()) {
        out << "*** Mismatch: " << std::string(58, '*') << std::endl;
        out << "vector:        " << VectorToString(v) << std::endl;
        out << "sparse vector: " << VectorToString(sv) << std::endl;
        out << std::string(72, '*') << std::endl;
        ++local_errors;
      }
      return local_errors;
    } // check()

template<typename T>

size_t TestManagerClass< T >::current_vector_size ( ) const

inline

Returns the current size of the STL vector.

Definition at line 119 of file sparse_vector_test.cc.

{ return v.size(); }

template<typename T>

bool TestManagerClass< T >::match ( ) const

inline

Definition at line 162 of file sparse_vector_test.cc.

{ return std::equal(v.begin(), v.end(), sv.begin()); }

template<typename T>

void TestManagerClass< T >::mirror ( )

inline

Set the vector as a copy of the sparse vector.

Definition at line 231 of file sparse_vector_test.cc.

{ v.assign(sv.cbegin(), sv.cend()); }

template<typename T>

unsigned int TestManagerClass< T >::operator() ( const Action_t &  action )

inline

Definition at line 224 of file sparse_vector_test.cc.

{ return perform(action); }

template<typename T>

unsigned int TestManagerClass< T >::perform ( const Action_t &  action, bool  autoCorrect = true  )

inline

Perform the specified action and evaluate the result.

Parameters

action	the action to be performed
autoCorrect	if on failure the sparse vector is copied from vector

Returns

number of detected errors

Definition at line 192 of file sparse_vector_test.cc.

    {
      out << "[" << ++nAction << "] ";
      action.describe(*this);
      out << std::endl;
      run(action);
      if (quietness <= 0) {
        out << "    => ";
        PrintVectorRanges(sv) << std::endl;
      }
      unsigned int errors = check();
      if (action.expected_errors != 0) {
        out << "  (" << action.expected_errors << " error(s) expected)"
          << std::endl;
      }
      if ((int)errors != action.expected_errors) {
        int actual_errors = abs(errors - action.expected_errors);
        nErrors += actual_errors;
        failures.emplace_back(*this, action, actual_errors);
        if (autoCorrect) {
          recover();
          if (!match())
            out << "   *** recovery from error failed ***" << std::endl;
        } // if autoCorrect
      } // if errors
      return errors;
    } // perform()

template<typename T>

int TestManagerClass< T >::quiet ( int  nq = 0 )

inline

Definition at line 221 of file sparse_vector_test.cc.

{ int q = quietness; quietness = nq; return q; }

template<typename T>

void TestManagerClass< T >::recover ( )

inline

Set the sparse vector as a copy of the vector (lossy!)

Definition at line 228 of file sparse_vector_test.cc.

{ sv.assign(v); sv.optimize(); }

template<typename T>

void TestManagerClass< T >::run ( const Action_t &  action )

inline

Definition at line 179 of file sparse_vector_test.cc.

    {
      action(v);
      action(sv);
    } // run()

template<typename T>

int TestManagerClass< T >::summary ( ) const

inline

Print a summary of the failures.

Definition at line 234 of file sparse_vector_test.cc.

    {
      out << nAction << " tests performed";
      if (nErrors == 0) {
        out << " successfully." << std::endl;
      }
      else {
        out << ", " << nErrors << " unexpected errors occurred in "
          << failures.size() << " of them:" << std::endl;
        for (const FailureInfo_t& info: failures) {
          out << "  [" << info.nAction << "] " << info.description
            << " => " << info.nErrors << " errors" << std::endl;
        } // for
      } // if errors
      return nErrors;
    } // summary()

template<typename T>

bool TestManagerClass< T >::validate ( ) const

inline

Checks if the sparse vector is valid.

Definition at line 123 of file sparse_vector_test.cc.

    {
      const auto ranges = sv.get_ranges();
      // a sparse vector with no non-null elements can't be detected invalid
      if (ranges.empty()) {
      //  std::cout << "[vector is void]" << std::endl;
        return true;
      }
      int i = 0;
      auto iNext = ranges.cbegin(), rend = ranges.cend();
      while (iNext != rend) {
        auto iRange = iNext++;
        if (iRange->empty()) {
          out << "[range " << i << " is empty]" << std::endl;
          return false;
        }
        if (iNext != rend) {
          if (!(*iRange < *iNext)) {
            out << "[range " << i << " comes after range " << (i+1) << "]"
              << std::endl;
            return false;
          }
          if (!iRange->separate(*iNext)) {
            out << "[range " << i << " is overlapping or adjacent to "
              << (i+1) << "]" << std::endl;
            return false;
          }
        }
        ++i;
      } // while
      if (sv.size() < ranges.back().end_index()) {
        out << "[size is " << sv.size() << ", it should be at least "
          << ranges.back().end_index() << "]" << std::endl;
        return false;
      }
      return true;
    } // validate()

Member Data Documentation

template<typename T>

std::vector<FailureInfo_t> TestManagerClass< T >::failures

documentation of the failures

Definition at line 107 of file sparse_vector_test.cc.

template<typename T>

unsigned int TestManagerClass< T >::nAction {0}

number of actions taken so far

Definition at line 105 of file sparse_vector_test.cc.

template<typename T>

unsigned int TestManagerClass< T >::nErrors {0}

number of errors accumulated

Definition at line 106 of file sparse_vector_test.cc.

template<typename T>

std::ostream& TestManagerClass< T >::out

output stream

Definition at line 111 of file sparse_vector_test.cc.

template<typename T>

int TestManagerClass< T >::quietness {0}

verbosity level (larger is less verbose)

Definition at line 109 of file sparse_vector_test.cc.

template<typename T>

SparseVector_t TestManagerClass< T >::sv {}

sparse vector to operate on

Definition at line 104 of file sparse_vector_test.cc.

template<typename T>

Vector_t TestManagerClass< T >::v {}

vector to operate on

Definition at line 103 of file sparse_vector_test.cc.

---

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

• lardataobj/test/Utilities/sparse_vector_test.cc