TECA
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
teca_dataset_diff Class Reference

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

#include <teca_dataset_diff.h>

Inheritance diagram for teca_dataset_diff:
teca_algorithm

Public Member Functions

std::shared_ptr< teca_dataset_diffshared_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_diffoperator= (const teca_dataset_diff &src)=delete
 
teca_dataset_diffoperator= (teca_dataset_diff &&src)=delete
 
const char * get_class_name () const override
 
void set_relative_tolerance (const double &v)
 
const double & get_relative_tolerance () const
 
void set_absolute_tolerance (const double &v)
 
const double & get_absolute_tolerance () const
 
void set_verbose (const int &v)
 
const int & get_verbose () const
 
- Public Member Functions inherited from teca_algorithm
 teca_algorithm (const teca_algorithm &src)=delete
 
 teca_algorithm (teca_algorithm &&src)=delete
 
teca_algorithmoperator= (const teca_algorithm &src)=delete
 
teca_algorithmoperator= (teca_algorithm &&src)=delete
 
void set_communicator (MPI_Comm comm)
 
MPI_Comm get_communicator ()
 
virtual teca_algorithm_output_port get_output_port (unsigned int port=0)
 
void set_input_connection (const teca_algorithm_output_port &port)
 
virtual void set_input_connection (unsigned int id, const teca_algorithm_output_port &port)
 
virtual void remove_input_connection (unsigned int id)
 
void clear_input_connections ()
 
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)
 
virtual int update ()
 
virtual int update (unsigned int port)
 
virtual teca_metadata update_metadata (unsigned int port=0)
 
void set_executive (p_teca_algorithm_executive exe)
 
p_teca_algorithm_executive get_executive ()
 
virtual void to_stream (std::ostream &s) const
 
virtual void from_stream (std::istream &s)
 

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)
 
int compare_arrays (const_p_teca_variant_array array1, const_p_teca_variant_array array2, double absTol, double relTol)
 
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)
 
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)
 
unsigned int get_number_of_input_connections ()
 
teca_algorithm_output_port & get_input_connection (unsigned int i)
 
void clear_modified (unsigned int port)
 
int get_modified (unsigned int port) const
 

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.


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