#include <teca_table_sort.h>

Inheritance diagram for teca_table_sort:

Collaboration diagram for teca_table_sort:

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

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

	teca_table_sort (const teca_table_sort &src)=delete

	teca_table_sort (teca_table_sort &&src)=delete

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

teca_table_sort &	operator= (teca_table_sort &&src)=delete

const char *	get_class_name () const override

index_column
Set the name of the column to sort by.
void	set_index_column (const std::string &v)

const std::string &	get_index_column () const

index_column_id
Set the number of the column to sort by.
void	set_index_column_id (const int &v)

const int &	get_index_column_id () const

stable_sort
Enable or disable stable sort. The default is disabled.
void	set_stable_sort (const int &v)

const int &	get_stable_sort () const

void	enable_stable_sort ()
	Enables stable sort. More...

void	disable_stable_sort ()
	Disable stable sort. More...

ascending_order
Set the sort order to ascending. the default is descending.
void	set_ascending_order (const int &v)

const int &	get_ascending_order () const

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_table_sort	New ()

Additional Inherited Members
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_output_metadata (unsigned int port, const std::vector< teca_metadata > &input_md)

virtual std::vector< teca_metadata >	get_upstream_request (unsigned int port, const std::vector< teca_metadata > &input_md, const teca_metadata &request)

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...

Protected Attributes inherited from teca_algorithm
int	verbose

Detailed Description

@breif An algorithm that sorts the rows of a table using the values in a specified column.

The sort can be done in ascending or descending order and a stable algorithm (i.e. one which does not change the order of equivalent elements) can be used. The table sort is especially useful when TECA's threaded algorithms, such as teca_table_reduce, produce in tables with a non-deterministic order.

Member Function Documentation

◆ disable_stable_sort()

void teca_table_sort::disable_stable_sort ( )

inline

Disable stable sort.

◆ enable_stable_sort()

void teca_table_sort::enable_stable_sort ( )

inline

Enables stable sort.

◆ get_ascending_order()

const int& teca_table_sort::get_ascending_order ( ) const

inline

Get the value of the ascending_order algorithm property

◆ get_class_name()

const char* teca_table_sort::get_class_name ( ) const

inlineoverridevirtual

returns the name of the class

Implements teca_algorithm.

◆ get_index_column()

const std::string& teca_table_sort::get_index_column ( ) const

inline

Get the value of the index_column algorithm property

◆ get_index_column_id()

const int& teca_table_sort::get_index_column_id ( ) const

inline

Get the value of the index_column_id algorithm property

◆ get_stable_sort()

const int& teca_table_sort::get_stable_sort ( ) const

inline

Get the value of the stable_sort algorithm property

◆ New()

static p_teca_table_sort teca_table_sort::New ( )

inlinestatic

Returns an instance of teca_table_sort

◆ set_ascending_order()

void teca_table_sort::set_ascending_order ( const int & v )

inline

Set the value of the ascending_order algorithm property

◆ set_index_column()

void teca_table_sort::set_index_column ( const std::string & v )

inline

Set the value of the index_column algorithm property

◆ set_index_column_id()

void teca_table_sort::set_index_column_id ( const int & v )

inline

Set the value of the index_column_id algorithm property

◆ set_stable_sort()

void teca_table_sort::set_stable_sort ( const int & v )

inline

Set the value of the stable_sort algorithm property

◆ shared_from_this() [1/2]

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

inline

Enables the static constructor

◆ shared_from_this() [2/2]

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

inline

Enables the static constructor

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

develop/alg/teca_table_sort.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ disable_stable_sort()

◆ enable_stable_sort()

◆ get_ascending_order()

◆ get_class_name()

◆ get_index_column()

◆ get_index_column_id()

◆ get_stable_sort()

◆ New()

◆ set_ascending_order()

◆ set_index_column()

◆ set_index_column_id()

◆ set_stable_sort()

◆ shared_from_this() [1/2]

◆ shared_from_this() [2/2]