OKlibrary  0.2.1.6
OKlib::InputOutput::Statistics< Int > Class Template Reference

Class for gathering statistics about input/output (especially in DIMACS format). More...

#include <ClauseSetAdaptors.hpp>

List of all members.

Public Types

typedef Int int_type

Public Member Functions

 Statistics ()
Statisticspn (const int_type v)
int_type pn () const
bool pn_entered () const
Statisticspc (const int_type v)
int_type pc () const
bool pc_entered () const
Statisticsn (const int_type v)
int_type n () const
bool n_entered () const
Statisticsn0 (const int_type v)
int_type n0 () const
bool n0_entered () const
Statisticsnmi (const int_type v)
int_type nmi () const
bool nmi_entered () const
Statisticsn0mi (const int_type v)
int_type n0mi () const
bool n0mi_entered () const
Statisticstcadd (const int_type v)
int_type tc () const
Statisticscadd (const int_type v)
int_type c () const
Statisticsladd (const int_type v)
int_type l () const
Statisticsl0add (const int_type v)
int_type l0 () const
Statisticscommentsadd (const int_type v)
int_type comments () const
Statisticsfinished (const bool v)
bool finished () const

Friends

bool operator== (const Statistics &lhs, const Statistics &rhs)
std::ostream & operator<< (std::ostream &out, const Statistics &s)

Detailed Description

template<typename Int = int>
class OKlib::InputOutput::Statistics< Int >

Class for gathering statistics about input/output (especially in DIMACS format).

Meaning of data members:

  • comment_count ("cmts"): number of comment-lines
  • parameter_n ("pn"): value of the first parameter in the parameter line
  • parameter_c ("pc") : value of the second parameter in the parameter line
  • variables ("n"): the number of actually occurring clauses after elementary reductions
  • variables_orig ("n0"): the number of actually occurring clauses in the original input (taking tautological clauses into account)
  • variables_maxindex ("nmi"): the maximal index of (occurring) variables after elementary reductions
  • variables_maxindex_orig ("n0mi"): the maximal index of (occurring) variables in the original input (taking tautological clauses into account)
  • tautological_clauses_count : number of tautological clauses (in the original input); this number is c0 - c
  • non_tautological_clauses_count ("c") : number of non-tautological clauses
  • total_number_literals ("l0") : number of literal occurrences in tautological and non-tautological clauses together
  • reduced_number_literals ("l") : number of literal occurrences after elementary reductions
  • finished : clause-set has been completely read
  • pne, pce, ne, n0e, nmie, n0mie: whether pn, pc, n, n0, nmi or n0mi has been entered or not.

"Elementary reductions" here is the elimination of tautological clauses and elimination of repeated literals in clauses.

Todo:
For the output better a message-class is provided.
Todo:
Create a concept

Definition at line 139 of file ClauseSetAdaptors.hpp.


Member Typedef Documentation

template<typename Int = int>
typedef Int OKlib::InputOutput::Statistics< Int >::int_type

Definition at line 141 of file ClauseSetAdaptors.hpp.


Constructor & Destructor Documentation

template<typename Int = int>
OKlib::InputOutput::Statistics< Int >::Statistics ( ) [inline]

Definition at line 158 of file ClauseSetAdaptors.hpp.


Member Function Documentation

template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::c ( ) const [inline]

Definition at line 190 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::comments ( ) const [inline]

Definition at line 199 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
bool OKlib::InputOutput::Statistics< Int >::finished ( ) const [inline]

Definition at line 202 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::l ( ) const [inline]

Definition at line 193 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::l0 ( ) const [inline]

Definition at line 196 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
Statistics& OKlib::InputOutput::Statistics< Int >::n ( const int_type  v) [inline]
template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::n ( ) const [inline]

Definition at line 171 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
Statistics& OKlib::InputOutput::Statistics< Int >::n0 ( const int_type  v) [inline]

Definition at line 174 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::n0 ( ) const [inline]

Definition at line 175 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
bool OKlib::InputOutput::Statistics< Int >::n0_entered ( ) const [inline]

Definition at line 176 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
Statistics& OKlib::InputOutput::Statistics< Int >::n0mi ( const int_type  v) [inline]

Definition at line 182 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::n0mi ( ) const [inline]

Definition at line 183 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
bool OKlib::InputOutput::Statistics< Int >::n0mi_entered ( ) const [inline]

Definition at line 184 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
bool OKlib::InputOutput::Statistics< Int >::n_entered ( ) const [inline]

Definition at line 172 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
Statistics& OKlib::InputOutput::Statistics< Int >::nmi ( const int_type  v) [inline]
template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::nmi ( ) const [inline]

Definition at line 179 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
bool OKlib::InputOutput::Statistics< Int >::nmi_entered ( ) const [inline]

Definition at line 180 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::pc ( ) const [inline]

Definition at line 167 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
bool OKlib::InputOutput::Statistics< Int >::pc_entered ( ) const [inline]

Definition at line 168 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::pn ( ) const [inline]

Definition at line 163 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
bool OKlib::InputOutput::Statistics< Int >::pn_entered ( ) const [inline]

Definition at line 164 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
int_type OKlib::InputOutput::Statistics< Int >::tc ( ) const [inline]

Definition at line 187 of file ClauseSetAdaptors.hpp.


Friends And Related Function Documentation

template<typename Int = int>
std::ostream& operator<< ( std::ostream &  out,
const Statistics< Int > &  s 
) [friend]

Definition at line 221 of file ClauseSetAdaptors.hpp.

template<typename Int = int>
bool operator== ( const Statistics< Int > &  lhs,
const Statistics< Int > &  rhs 
) [friend]

Definition at line 205 of file ClauseSetAdaptors.hpp.


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