o2scl_hdf Namespace Reference

The O2scl namespace for I/O with HDF.

Classes
class	cloud_file
	Read a file and download from a URL if necessary. More...
class	hdf_file
	Store data in an O2scl compatible HDF5 file. More...

Functions
template<class vec_t >
void	hdf_input (hdf_file &hf, o2scl::table< vec_t > &t, std::string name)
	Input a o2scl::table object from a hdf_file. More...
void	hdf_output (hdf_file &hf, o2scl::table< std::vector< double > > &t, std::string name)
template<class vec_t >
void	hdf_input_data (hdf_file &hf, o2scl::table< vec_t > &t)
	Internal function for inputting a o2scl::table object.
void	hdf_output_data (hdf_file &hf, o2scl::table< std::vector< double > > &t)
void	hdf_input (hdf_file &hf, o2scl::table3d &h, std::string name="")
	Input a o2scl::table3d object from a hdf_file.
void	hdf_output (hdf_file &hf, o2scl::table3d &t, std::string name)
template<class vec_t >
void	hdf_input (hdf_file &hf, o2scl::table_units< vec_t > &t, std::string name)
	Input a o2scl::table_units object from a hdf_file. More...
void	hdf_output (hdf_file &hf, o2scl::table_units< std::vector< double > > &t, std::string name)
template<class vec_t >
void	hdf_input_data (hdf_file &hf, o2scl::table_units< vec_t > &t)
	Internal function for inputting a o2scl::table_units object.
void	hdf_output_data (hdf_file &hf, o2scl::table_units< std::vector< double > > &t)
template<class vec_t , class vec_size_t >
void	hdf_input (hdf_file &hf, o2scl::tensor_grid< vec_t, vec_size_t > &t, std::string name)
template<class vec_t , class vec_size_t >
void	hdf_output (hdf_file &hf, o2scl::tensor_grid< vec_t, vec_size_t > &t, std::string name)
void	hdf_input (hdf_file &hf, o2scl::uniform_grid< double > &h, std::string name="")
	Input a o2scl::uniform_grid object from a hdf_file.
void	hdf_output (hdf_file &hf, o2scl::uniform_grid< double > &h, std::string name)
	Output a o2scl::uniform_grid object to a hdf_file.
template<class vec_t , class mat_t >
void	hdf_input (hdf_file &hf, o2scl::prob_dens_mdim_amr< vec_t, mat_t > &p, std::string name)
	Input a o2scl::prob_dens_mdim_amr object from a hdf_file.
template<class vec_t , class mat_t >
void	hdf_output (hdf_file &hf, o2scl::prob_dens_mdim_amr< vec_t, mat_t > &p, std::string name)
	Output a o2scl::prob_dens_mdim_amr object to a hdf_file.
void	hdf_output (hdf_file &hf, o2scl::table<> &t, std::string name)
	Output a o2scl::table object to a hdf_file.
void	hdf_output_data (hdf_file &hf, o2scl::table<> &t)
	Internal function for outputting a o2scl::table object.
void	hdf_output (hdf_file &hf, o2scl::table_units<> &t, std::string name)
	Output a o2scl::table_units object to a hdf_file.
void	hdf_output_data (hdf_file &hf, o2scl::table_units<> &t)
	Internal function for outputting a o2scl::table_units object.
void	hdf_output (hdf_file &hf, o2scl::hist &h, std::string name)
	Output a o2scl::hist object to a hdf_file.
void	hdf_input (hdf_file &hf, o2scl::hist &h, std::string name="")
	Input a o2scl::hist object from a hdf_file.
void	hdf_output (hdf_file &hf, const o2scl::hist_2d &h, std::string name)
	Output a o2scl::hist_2d object to a hdf_file.
void	hdf_input (hdf_file &hf, o2scl::hist_2d &h, std::string name="")
	Input a o2scl::hist_2d object from a hdf_file.
void	hdf_output (hdf_file &hf, const o2scl::table3d &h, std::string name)
	Output a o2scl::table3d object to a hdf_file.
void	hdf_output (hdf_file &hf, o2scl::expval_scalar &h, std::string name)
	Output a o2scl::expval_scalar object to a hdf_file.
void	hdf_input (hdf_file &hf, o2scl::expval_scalar &h, std::string name="")
	Input a o2scl::expval_scalar object from a hdf_file.
void	hdf_output (hdf_file &hf, o2scl::expval_vector &h, std::string name)
	Output a o2scl::expval_vector object to a hdf_file.
void	hdf_input (hdf_file &hf, o2scl::expval_vector &h, std::string name="")
	Input a o2scl::expval_vector object from a hdf_file.
void	hdf_output (hdf_file &hf, o2scl::expval_matrix &h, std::string name)
	Output a o2scl::expval_matrix object to a hdf_file.
void	hdf_input (hdf_file &hf, o2scl::expval_matrix &h, std::string name="")
	Input a o2scl::expval_matrix object from a hdf_file.
void	hdf_output (hdf_file &hf, const std::vector< o2scl::contour_line > &cl, std::string name)
	Output a vector of o2scl::contour_line objects to a hdf_file.
void	hdf_input (hdf_file &hf, std::vector< o2scl::contour_line > &cl, std::string name="")
	Input a vector of o2scl::contour_line objects from a hdf_file.
void	hdf_output (hdf_file &hf, const std::vector< o2scl::edge_crossings > &ec, std::string name)
	Output a vector of o2scl::edge_crossings objects to a hdf_file.
void	hdf_input (hdf_file &hf, std::vector< o2scl::edge_crossings > &ec, std::string name="")
	Input a vector of o2scl::edge_crossings objects from a hdf_file.
void	hdf_output (hdf_file &hf, o2scl::tensor_grid< std::vector< double >, std::vector< size_t > > &t, std::string name)
	Output a o2scl::tensor_grid object to a hdf_file.
void	hdf_input (hdf_file &hf, o2scl::tensor_grid< std::vector< double >, std::vector< size_t > > &t, std::string name="")
	Input a o2scl::tensor_grid object from a hdf_file.
int	value_spec (std::string spec, double &d, int verbose=0, bool err_on_fail=true)
	A value specified by a string. More...
template<class vec_t >
int	vector_spec (std::string spec, vec_t &v, int verbose=0, bool err_on_fail=true)
	A vector specified by a string. More...
template<class vec_t >
int	strings_spec (std::string spec, vec_t &v, int verbose=0, bool err_on_fail=true)
	Desc.
std::vector< double >	vector_spec (std::string spec)
	Return a std vector specified by a string.
template<class vec_t >
int	mult_vector_spec (std::string spec, std::vector< vec_t > &v, int verbose=0, bool err_on_fail=true)
	A list of vectors specified by a string. More...
void	hdf_output (hdf_file &hf, o2scl::hist_2d &t, std::string name)

Function Documentation

hdf_input() [1/2]

template<class vec_t >

void o2scl_hdf::hdf_input	(	hdf_file &	hf,
		o2scl::table< vec_t > &	t,
		std::string	name
	)

Definition at line 148 of file hdf_io.h.

hdf_input() [2/2]

template<class vec_t >

void o2scl_hdf::hdf_input	(	hdf_file &	hf,
		o2scl::table_units< vec_t > &	t,
		std::string	name
	)

Definition at line 272 of file hdf_io.h.

mult_vector_spec()

template<class vec_t >

int o2scl_hdf::mult_vector_spec	(	std::string	spec,
		std::vector< vec_t > &	v,
		int	verbose = 0,
		bool	err_on_fail = true
	)

Formats:

• function: func:<num>:<len(i)>:<function of i and j>
• columns in text file: text:<column index list>
• HDF5 object(s) in file(s): hdf5:<file name(s)>:<object name(s)>:[additional specification]

Note

unfinished.

Definition at line 1001 of file hdf_io.h.

value_spec()

int o2scl_hdf::value_spec	(	std::string	spec,
		double &	d,
		int	verbose = 0,
		bool	err_on_fail = true
	)

Formats:

• func: <function>

• HDF5 object in file: hdf5:<file name>:<object name>:[additional specification]

  Todo:

  shell: option to use the result of a shell command

Note

unfinished.

vector_spec()

template<class vec_t >

int o2scl_hdf::vector_spec	(	std::string	spec,
		vec_t &	v,
		int	verbose = 0,
		bool	err_on_fail = true
	)

Formats:

• single value: val:<value>
• list of values: list:<entry 0>,<entry 1>, ...,<entry n-1>
• function: func:<N>:<function of i>
• grid: grid:<begin>:<end>:<width>:["log"]
• column in text file: text:<filename>:<column index>
• HDF5 object in file: hdf5:<file name>:<object name>:[additional specification]

Filenames are expanded using wordexp() and HDF5 object names are expanded using fnmatch() .

Additional specifications

• table: <column>

Definition at line 419 of file hdf_io.h.