compute the element wise difference between to datasets More...

#include <teca_dataset_diff.h>

Inheritance diagram for teca_dataset_diff:

Collaboration diagram for teca_dataset_diff:

Public Member Functions
std::shared_ptr< teca_dataset_diff >	shared_from_this ()

std::shared_ptr< teca_dataset_diff const >	shared_from_this () const

	teca_dataset_diff (const teca_dataset_diff &src)=delete

	teca_dataset_diff (teca_dataset_diff &&src)=delete

teca_dataset_diff &	operator= (const teca_dataset_diff &src)=delete

teca_dataset_diff &	operator= (teca_dataset_diff &&src)=delete

const char *	get_class_name () const override

relative_tolerance
Relative tolerance below which two floating-point numbers a and b are considered equal. if \|a - b\| <= max(\|a\|,\|b\|)*tol then a is equal to b. the relative tolerance is used with numbers not close to zero.
void	set_relative_tolerance (const double &v)

const double &	get_relative_tolerance () const

absolute_tolerance
The absolute tolerance below which two floating point numbers a and b are considered equal. if \|a - b\| <= tol then a is equal to b. The absolute tolerance is used with numbers close to zero.
void	set_absolute_tolerance (const double &v)

const double &	get_absolute_tolerance () const

skip_arrays
A list of arrays that are ignored during tests.
size_t	get_number_of_skip_arrays ()

void	append_skip_array (const std::string &v)

void	set_skip_array (const std::string &v)

void	set_skip_array (size_t i, const std::string &v)

void	set_skip_arrays (const std::vector< std::string > &v)

void	set_skip_arrays (const std::initializer_list< std::string > &&l)

const std::string &	get_skip_array (size_t i) const

const std::vector< std::string > &	get_skip_arrays () const

void	clear_skip_arrays ()

Public Member Functions inherited from teca_algorithm
	teca_algorithm (const teca_algorithm &src)=delete

	teca_algorithm (teca_algorithm &&src)=delete

teca_algorithm &	operator= (const teca_algorithm &src)=delete

teca_algorithm &	operator= (teca_algorithm &&src)=delete

void	set_communicator (MPI_Comm comm)

MPI_Comm	get_communicator ()
	get the active communicator More...

virtual teca_algorithm_output_port	get_output_port (unsigned int port=0)

void	set_input_connection (const teca_algorithm_output_port &port)
	set an input to this algorithm More...

virtual void	set_input_connection (unsigned int id, const teca_algorithm_output_port &port)
	set an input to this algorithm More...

virtual void	remove_input_connection (unsigned int id)
	remove input connections More...

void	clear_input_connections ()
	remove all input connections More...

const_p_teca_dataset	get_output_data (unsigned int port=0)

void	pop_cache (unsigned int port=0, int top=0)

void	set_cache_size (unsigned int n)
	set the cache size. the default is 1. (threadsafe) More...

virtual int	update ()
	execute the pipeline from this instance up. More...

virtual int	update (unsigned int port)
	execute the pipeline from this instance up. More...

virtual teca_metadata	update_metadata (unsigned int port=0)
	get meta data considering this instance up. More...

void	set_executive (p_teca_algorithm_executive exe)
	set the executive More...

p_teca_algorithm_executive	get_executive ()
	get the executive More...

virtual void	to_stream (std::ostream &s) const

virtual void	from_stream (std::istream &s)
	deserialize from the stream. More...

void	set_verbose (const int &v)

const int &	get_verbose () const

Static Public Member Functions
static p_teca_dataset_diff	New ()

Protected Member Functions
int	compare_tables (const_p_teca_table table1, const_p_teca_table table2)

int	compare_meshes (const_p_teca_mesh reference_mesh, const_p_teca_mesh data_mesh)

int	compare_cartesian_meshes (const_p_teca_cartesian_mesh reference_mesh, const_p_teca_cartesian_mesh data_mesh)

int	compare_curvilinear_meshes (const_p_teca_curvilinear_mesh reference_mesh, const_p_teca_curvilinear_mesh data_mesh)

int	compare_arakawa_c_grids (const_p_teca_arakawa_c_grid reference_mesh, const_p_teca_arakawa_c_grid data_mesh)

int	compare_array_collections (const_p_teca_array_collection reference_arrays, const_p_teca_array_collection data_arrays)

void	datasets_differ (const char *info,...)

Protected Member Functions inherited from teca_algorithm
void	set_number_of_input_connections (unsigned int n)

void	set_number_of_output_ports (unsigned int n)

virtual void	set_modified ()

void	set_modified (unsigned int port)
	an overload to set_modified by port More...

virtual teca_metadata	get_cache_key (unsigned int port, const teca_metadata &request) const

virtual teca_metadata	get_output_metadata (teca_algorithm_output_port &current)

virtual const_p_teca_dataset	request_data (teca_algorithm_output_port &port, const teca_metadata &request)

virtual int	validate_cache (teca_algorithm_output_port &current)

virtual void	clear_modified (teca_algorithm_output_port current)

const_p_teca_dataset	get_output_data (unsigned int port, const teca_metadata &request)

int	cache_output_data (unsigned int port, const teca_metadata &request, const_p_teca_dataset &data)

void	clear_cache (unsigned int port)
	clear the cache on the given output port More...

unsigned int	get_number_of_input_connections ()
	get the number of input connections More...

teca_algorithm_output_port &	get_input_connection (unsigned int i)

void	clear_modified (unsigned int port)
	clear the modified flag on the i'th output More...

int	get_modified (unsigned int port) const
	return the output port's modified flag value More...

Additional Inherited Members
Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

compute the element wise difference between to datasets

a two input algorithm that compares datasets by examining each element of their contained arrays. a threshold is used to detect when an element is different. a report containing the string FAIL is issued to stderr stream when a difference is detected. this algorithm is the core of TECA's regression test suite.

by convention the first input produces the reference dataset, and the second input produces the dataset to validate. this is primarilly to support map-reduce implementation where after the reduction only rank 0 has data.

Member Function Documentation

◆ append_skip_array()

void teca_dataset_diff::append_skip_array ( const std::string & v )

inline

append to the skip_array algorithm vector property

◆ clear_skip_arrays()

void teca_dataset_diff::clear_skip_arrays ( )

inline

clear the skip_array algorithm vector property

◆ get_absolute_tolerance()

const double& teca_dataset_diff::get_absolute_tolerance ( ) const

inline

Get the value of the absolute_tolerance algorithm property

◆ get_class_name()

const char* teca_dataset_diff::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_number_of_skip_arrays()

size_t teca_dataset_diff::get_number_of_skip_arrays ( )

inline

get the size of the skip_array algorithm vector property

◆ get_relative_tolerance()

const double& teca_dataset_diff::get_relative_tolerance ( ) const

inline

Get the value of the relative_tolerance algorithm property

◆ get_skip_array()

const std::string& teca_dataset_diff::get_skip_array ( size_t i ) const

inline

get the i-th element of the skip_array algorithm vector property

◆ get_skip_arrays()

const std::vector< std::string >& teca_dataset_diff::get_skip_arrays ( ) const

inline

get the skip_array algorithm vector property

◆ New()

static p_teca_dataset_diff teca_dataset_diff::New ( )

inlinestatic

Returns an instance of teca_dataset_diff

◆ set_absolute_tolerance()

void teca_dataset_diff::set_absolute_tolerance ( const double & v )

inline

Set the value of the absolute_tolerance algorithm property

◆ set_relative_tolerance()

void teca_dataset_diff::set_relative_tolerance ( const double & v )

inline

Set the value of the relative_tolerance algorithm property

◆ set_skip_array() [1/2]

void teca_dataset_diff::set_skip_array ( const std::string & v )

inline

set the skip_array algorithm vector property to a single value

◆ set_skip_array() [2/2]

void teca_dataset_diff::set_skip_array	(	size_t	i,
		const std::string &	v
	)

inline

set the i-th element of the skip_array algorithm vector property

◆ set_skip_arrays() [1/2]

void teca_dataset_diff::set_skip_arrays ( const std::initializer_list< std::string > && l )

inline

set the skip_array algorithm vector property

◆ set_skip_arrays() [2/2]

void teca_dataset_diff::set_skip_arrays ( const std::vector< std::string > & v )

inline

set the skip_array algorithm vector property

◆ shared_from_this() [1/2]

std::shared_ptr< teca_dataset_diff > teca_dataset_diff::shared_from_this ( )

inline

Enables the static constructor

◆ shared_from_this() [2/2]

std::shared_ptr< teca_dataset_diff const> teca_dataset_diff::shared_from_this ( ) const

inline

Enables the static constructor

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

develop/alg/teca_dataset_diff.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ append_skip_array()

◆ clear_skip_arrays()

◆ get_absolute_tolerance()

◆ get_class_name()

◆ get_number_of_skip_arrays()

◆ get_relative_tolerance()

◆ get_skip_array()

◆ get_skip_arrays()

◆ New()

◆ set_absolute_tolerance()

◆ set_relative_tolerance()

◆ set_skip_array() [1/2]

◆ set_skip_array() [2/2]

◆ set_skip_arrays() [1/2]

◆ set_skip_arrays() [2/2]

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]