Write and read objects to/from file. More...
#include <FileWritable.h>
Classes | |
struct | Manager |
struct | Stats |
Public Member Functions | |
void | writeToFile () |
Write object to file if filewrite is active. | |
void | readFromFile () |
Read object from file if filewrite is active. | |
void | copyToFile (const char *destFileName) |
void | copyFromFile (const char *sourceFileName) |
bool | isOnFile () |
Check if object is on file. | |
long int | fileSize () |
Return file size. | |
Static Public Member Functions | |
static void | setPath (char const *const newPath) |
Set the path to which the objects will be written. | |
static void | activate () |
Activate the filewriting. | |
static std::string | getStatsFileSizes () |
static std::string | writeAndReadAll () |
static void | resetStats () |
static std::string | getStatsTimeWrite () |
static std::string | getStatsTimeRead () |
static std::string | getStatsTimeCopyAndAssign () |
static std::string | getStatsCountWrite () |
static std::string | getStatsCountRead () |
static std::string | getStatsCountCopyAndAssign () |
Protected Types | |
typedef std::map< std::string, double > | TypeTimeMap |
typedef std::map< std::string, int > | TypeCountMap |
typedef std::set< FileWritable * > | ObjPtrSet |
Protected Member Functions | |
virtual void | clear ()=0 |
Release memory for the information written to file. | |
virtual void | inMemorySet (bool)=0 |
Make object invalid (false) via this function when object is written to file and valid (true) when object is read from file. | |
virtual void | writeToFileProt (std::ofstream &) const =0 |
Write object to file. | |
virtual void | readFromFileProt (std::ifstream &)=0 |
Read object from file. | |
FileWritable () | |
Gives each object a unique ID-number and filename. | |
virtual | ~FileWritable () |
Removes file, if any. | |
FileWritable (FileWritable const &) | |
FileWritable & | operator= (FileWritable const &) |
virtual std::string | obj_type_id () const =0 |
Static Protected Member Functions | |
static std::string | getStatsTime (TypeTimeMap &theMap) |
static std::string | getStatsCount (TypeCountMap &theMap) |
static std::string | getStatsFileSizes (ObjPtrSet const &set) |
Private Attributes | |
unsigned int const | IDNumber |
Each object has its unique ID-number. | |
char * | fileName |
Each object has its unique filename. | |
bool | objectIsOnFile |
States whether the object is on file or not. | |
Static Private Attributes | |
static unsigned int | nObjects = 0 |
The number of instantiated objects. | |
static char * | path = NULL |
The path to which files will be written. | |
static bool | active = false |
States whether the filewriting is active. |
Write and read objects to/from file.
This is an abstract class. Classes that are derived from this class must define the following pure virtual functions to be able to instantiate objects:
typedef std::set<FileWritable*> mat::FileWritable::ObjPtrSet [protected] |
typedef std::map<std::string, int> mat::FileWritable::TypeCountMap [protected] |
typedef std::map<std::string, double> mat::FileWritable::TypeTimeMap [protected] |
mat::FileWritable::FileWritable | ( | ) | [protected] |
Gives each object a unique ID-number and filename.
References fileName, IDNumber, nObjects, path, and mat::FileWritable::Manager::registerObj().
mat::FileWritable::~FileWritable | ( | ) | [protected, virtual] |
Removes file, if any.
References active, fileName, objectIsOnFile, and mat::FileWritable::Manager::unRegisterObj().
mat::FileWritable::FileWritable | ( | FileWritable const & | other | ) | [protected] |
References active, mat::copy_file(), mat::FileWritable::Stats::countCopyAndAssign, fileName, IDNumber, mat::FileWritable::Stats::instance(), nObjects, obj_type_id(), objectIsOnFile, path, mat::FileWritable::Manager::registerObj(), mat::Time::tic(), mat::Time::toc(), and mat::FileWritable::Stats::wallTimeCopyAndAssign.
void mat::FileWritable::activate | ( | ) | [static] |
virtual void mat::FileWritable::clear | ( | ) | [protected, pure virtual] |
Release memory for the information written to file.
Implemented in mat::MatrixBase< Treal, Tmatrix >, mat::VectorGeneral< Treal, Tvector >, and mat::VectorGeneral< ergo_real, Vectorrr >.
Referenced by copyFromFile(), and writeToFile().
void mat::FileWritable::copyFromFile | ( | const char * | sourceFileName | ) |
References active, clear(), fileName, mat::get_file_size(), inMemorySet(), objectIsOnFile, and readFromFileProt().
Referenced by GetDensFromFock::restore_from_checkpoint().
void mat::FileWritable::copyToFile | ( | const char * | destFileName | ) |
References active, fileName, mat::get_file_size(), objectIsOnFile, readFromFile(), writeToFile(), and writeToFileProt().
Referenced by GetDensFromFock::create_checkpoint().
long int mat::FileWritable::fileSize | ( | ) |
std::string mat::FileWritable::getStatsCount | ( | TypeCountMap & | theMap | ) | [static, protected] |
Referenced by getStatsCountCopyAndAssign(), getStatsCountRead(), and getStatsCountWrite().
std::string mat::FileWritable::getStatsCountCopyAndAssign | ( | ) | [static] |
References getStatsCount(), and mat::FileWritable::Stats::instance().
Referenced by GetDensFromFock::get_dens_from_fock_sparse().
std::string mat::FileWritable::getStatsCountRead | ( | ) | [static] |
References getStatsCount(), and mat::FileWritable::Stats::instance().
Referenced by GetDensFromFock::get_dens_from_fock_sparse().
std::string mat::FileWritable::getStatsCountWrite | ( | ) | [static] |
References getStatsCount(), and mat::FileWritable::Stats::instance().
Referenced by GetDensFromFock::get_dens_from_fock_sparse().
std::string mat::FileWritable::getStatsFileSizes | ( | ObjPtrSet const & | set | ) | [static, protected] |
std::string mat::FileWritable::getStatsFileSizes | ( | ) | [static] |
References mat::FileWritable::Manager::instance().
Referenced by writeAndReadAll().
std::string mat::FileWritable::getStatsTime | ( | TypeTimeMap & | theMap | ) | [static, protected] |
Referenced by getStatsTimeCopyAndAssign(), getStatsTimeRead(), and getStatsTimeWrite().
std::string mat::FileWritable::getStatsTimeCopyAndAssign | ( | ) | [static] |
References getStatsTime(), and mat::FileWritable::Stats::instance().
Referenced by GetDensFromFock::get_dens_from_fock_sparse().
std::string mat::FileWritable::getStatsTimeRead | ( | ) | [static] |
References getStatsTime(), and mat::FileWritable::Stats::instance().
Referenced by GetDensFromFock::get_dens_from_fock_sparse().
std::string mat::FileWritable::getStatsTimeWrite | ( | ) | [static] |
References getStatsTime(), and mat::FileWritable::Stats::instance().
Referenced by GetDensFromFock::get_dens_from_fock_sparse().
virtual void mat::FileWritable::inMemorySet | ( | bool | ) | [protected, pure virtual] |
Make object invalid (false) via this function when object is written to file and valid (true) when object is read from file.
Implemented in mat::MatrixBase< Treal, Tmatrix >, mat::VectorGeneral< Treal, Tvector >, and mat::VectorGeneral< ergo_real, Vectorrr >.
Referenced by copyFromFile(), readFromFile(), and writeToFile().
bool mat::FileWritable::isOnFile | ( | ) | [inline] |
virtual std::string mat::FileWritable::obj_type_id | ( | ) | const [protected, pure virtual] |
Implemented in mat::MatrixBase< Treal, Tmatrix >, mat::MatrixGeneral< Treal, Tmatrix >, mat::MatrixSymmetric< Treal, Tmatrix >, mat::MatrixTriangular< Treal, Tmatrix >, mat::VectorGeneral< Treal, Tvector >, and mat::VectorGeneral< ergo_real, Vectorrr >.
Referenced by FileWritable(), operator=(), readFromFile(), and writeToFile().
FileWritable & mat::FileWritable::operator= | ( | FileWritable const & | other | ) | [protected] |
Reimplemented in mat::MatrixBase< Treal, Tmatrix >, mat::MatrixGeneral< Treal, Tmatrix >, mat::MatrixSymmetric< Treal, Tmatrix >, mat::MatrixTriangular< Treal, Tmatrix >, and mat::VectorGeneral< Treal, Tvector >.
References active, mat::copy_file(), mat::FileWritable::Stats::countCopyAndAssign, fileName, mat::FileWritable::Stats::instance(), obj_type_id(), objectIsOnFile, mat::Time::tic(), mat::Time::toc(), and mat::FileWritable::Stats::wallTimeCopyAndAssign.
void mat::FileWritable::readFromFile | ( | ) |
Read object from file if filewrite is active.
References active, mat::FileWritable::Stats::countRead, fileName, inMemorySet(), mat::FileWritable::Stats::instance(), obj_type_id(), objectIsOnFile, readFromFileProt(), mat::Time::tic(), mat::Time::toc(), and mat::FileWritable::Stats::wallTimeRead.
Referenced by copyToFile(), GetDensFromFock::create_checkpoint(), SCF_restricted::get_2e_part_and_energy(), SCF_unrestricted::get_FDSminusSDF(), SCF_restricted::get_FDSminusSDF(), mainFun(), GetDensFromFock::restore_from_checkpoint(), and SCF_restricted::transform_with_invChol().
virtual void mat::FileWritable::readFromFileProt | ( | std::ifstream & | ) | [protected, pure virtual] |
Read object from file.
Defined in derived class.
Implemented in mat::MatrixGeneral< Treal, Tmatrix >, mat::MatrixSymmetric< Treal, Tmatrix >, mat::MatrixTriangular< Treal, Tmatrix >, mat::VectorGeneral< Treal, Tvector >, and mat::VectorGeneral< ergo_real, Vectorrr >.
Referenced by copyFromFile(), and readFromFile().
void mat::FileWritable::resetStats | ( | ) | [static] |
References mat::FileWritable::Stats::countCopyAndAssign, mat::FileWritable::Stats::countRead, mat::FileWritable::Stats::countWrite, mat::FileWritable::Stats::instance(), mat::FileWritable::Stats::wallTimeCopyAndAssign, mat::FileWritable::Stats::wallTimeRead, and mat::FileWritable::Stats::wallTimeWrite.
Referenced by GetDensFromFock::get_dens_from_fock_sparse().
void mat::FileWritable::setPath | ( | char const *const | newPath | ) | [static] |
std::string mat::FileWritable::writeAndReadAll | ( | ) | [static] |
References getStatsFileSizes(), mat::FileWritable::Manager::instance(), and mat::FileWritable::Manager::obj_ptr_set.
Referenced by PurificationGeneral< MatrixType >::compute_eigenvectors_without_diagonalization_last_iter_proj(), compute_FDSminusSDF_sparse(), compute_J_by_boxes_sparse(), GetDensFromFock::get_dens_from_fock(), GetDensFromFock::get_dens_from_fock_sparse(), and PurificationGeneral< MatrixType >::purification_process().
void mat::FileWritable::writeToFile | ( | ) |
Write object to file if filewrite is active.
Object is "cleared" in this call.
References active, clear(), mat::FileWritable::Stats::countWrite, fileName, inMemorySet(), mat::FileWritable::Stats::instance(), obj_type_id(), objectIsOnFile, mat::Time::tic(), mat::Time::toc(), mat::FileWritable::Stats::wallTimeWrite, and writeToFileProt().
Referenced by copyToFile(), GetDensFromFock::create_checkpoint(), SCF_restricted::get_2e_part_and_energy(), SCF_unrestricted::get_FDSminusSDF(), SCF_restricted::get_FDSminusSDF(), mainFun(), and SCF_restricted::transform_with_invChol().
virtual void mat::FileWritable::writeToFileProt | ( | std::ofstream & | ) | const [protected, pure virtual] |
Write object to file.
Defined in derived class.
Implemented in mat::MatrixGeneral< Treal, Tmatrix >, mat::MatrixSymmetric< Treal, Tmatrix >, mat::MatrixTriangular< Treal, Tmatrix >, mat::VectorGeneral< Treal, Tvector >, and mat::VectorGeneral< ergo_real, Vectorrr >.
Referenced by copyToFile(), and writeToFile().
bool mat::FileWritable::active = false [static, private] |
States whether the filewriting is active.
Referenced by activate(), copyFromFile(), copyToFile(), fileSize(), FileWritable(), operator=(), readFromFile(), writeToFile(), and ~FileWritable().
char* mat::FileWritable::fileName [private] |
Each object has its unique filename.
Referenced by copyFromFile(), copyToFile(), fileSize(), FileWritable(), operator=(), readFromFile(), writeToFile(), and ~FileWritable().
unsigned int const mat::FileWritable::IDNumber [private] |
Each object has its unique ID-number.
Referenced by FileWritable().
unsigned int mat::FileWritable::nObjects = 0 [static, private] |
The number of instantiated objects.
Note that the objects may be of different types derived from this base class.
Referenced by activate(), FileWritable(), and setPath().
bool mat::FileWritable::objectIsOnFile [private] |
States whether the object is on file or not.
Referenced by copyFromFile(), copyToFile(), FileWritable(), isOnFile(), operator=(), readFromFile(), writeToFile(), and ~FileWritable().
char * mat::FileWritable::path = NULL [static, private] |
The path to which files will be written.
Referenced by FileWritable(), and setPath().