#include <subgroup_manager.h>

Inheritance diagram for pressio_subgroup_manager:

Collaboration diagram for pressio_subgroup_manager:

Public Member Functions
int	set_options (const struct pressio_options &options) override

struct pressio_options	get_documentation () const override

struct pressio_options	get_options () const override

const char *	prefix () const override

template<class U , class V >
int	normalize_and_validate (compat::span< U > const &inputs, compat::span< V > const &outputs)

template<class Span >
std::vector< pressio_data const * >	get_input_group (Span const &inputs, int idx) const

template<class Span >
std::vector< pressio_data * >	get_output_group (Span const &inputs, int idx) const

std::vector< int > const &	effective_input_groups () const

std::vector< int > const &	effective_output_groups () const

Public Member Functions inherited from pressio_configurable
virtual const char *	prefix () const =0

std::string const &	get_name () const

virtual void	set_name (std::string const &new_name)

virtual void	set_name_impl (std::string const &new_name)

virtual struct pressio_options	get_configuration () const

virtual struct pressio_options	get_documentation () const

virtual int	check_options (struct pressio_options const &)

virtual struct pressio_options	get_options () const

virtual int	set_options (struct pressio_options const &options)

int	cast_options (pressio_options const &early_config, pressio_options const &config)

Public Member Functions inherited from pressio_errorable
const char *	error_msg () const

int	error_code () const

Additional Inherited Members
Protected Member Functions inherited from pressio_configurable
template<class StringType >
void	set (pressio_options &options, StringType const &key, pressio_option const &value) const

template<class StringType >
void	set_type (pressio_options &options, StringType const &key, pressio_option_type type) const

template<class StringType , class PointerType >
enum pressio_options_key_status	get (pressio_options const &options, StringType &&key, PointerType value) const

template<class StringType , class Wrapper , class... Args>
void	set_meta (pressio_options &options, StringType &&key, std::string const &current_id, Wrapper const &current_value, Args &&... args) const

template<class StringType , class Wrapper , class... Args>
void	set_meta_docs (pressio_options &options, StringType &&key, std::string const &docstring, Wrapper const &current_value, Args &&... args) const

template<class StringType , class Wrapper , class Registry , class... Args>
void	set_meta_configuration (pressio_options &options, StringType &&key, Registry const &registry, Wrapper const &current_value) const

template<class StringType , class Wrapper , class Registry , class... Args>
void	set_meta_many_configuration (pressio_options &options, StringType &&key, Registry const &registry, std::vector< Wrapper > const &current_values) const

template<class StringType , class Wrapper , class... Args>
void	set_meta_many_docs (pressio_options &options, StringType &&key, std::string const &docstring, std::vector< Wrapper > const &current_values, Args &&... args) const

template<class StringType , class Wrapper , class... Args>
void	set_meta_many (pressio_options &options, StringType &&key, std::vector< std::string > const &current_ids, std::vector< Wrapper > const &current_values, Args &&... args) const

template<class StringType , class Registry , class Wrapper >
pressio_options_key_status	get_meta (pressio_options const &options, StringType &&key, Registry const &registry, std::string &current_id, Wrapper &current_value)

template<class StringType , class Registry , class Wrapper >
pressio_options_key_status	get_meta_many (pressio_options const &options, StringType &&key, Registry const &registry, std::vector< std::string > &current_ids, std::vector< Wrapper > &current_values)

template<class T >
void	set_names_many (std::string const &name, std::vector< T > &plugins, std::vector< std::string > const &names) const

std::string	get_metrics_key_name () const

Protected Member Functions inherited from pressio_errorable
int	set_error (int code, std::string const &msg)

void	clear_error ()

Static Protected Member Functions inherited from pressio_configurable
static pressio_thread_safety	get_threadsafe (pressio_configurable const &c)

Protected Attributes inherited from pressio_configurable
std::string	name

Detailed Description

a helper class to map input and output buffers to a meta-compressor

Member Function Documentation

◆ effective_input_groups()

std::vector< int > const & pressio_subgroup_manager::effective_input_groups ( ) const

inline

Returns: the effective input groups

◆ effective_output_groups()

std::vector< int > const & pressio_subgroup_manager::effective_output_groups ( ) const

inline

Returns: the effective outputs groups

◆ get_documentation()

struct pressio_options pressio_subgroup_manager::get_documentation ( ) const

inlineoverridevirtual

get the documentation strings for a compressor

See also: pressio_compressor_get_documentation for the semantics this function should obey

Reimplemented from pressio_configurable.

◆ get_input_group()

template<class Span >

std::vector< pressio_data const * > pressio_subgroup_manager::get_input_group	(	Span const &	inputs,
		int	idx
	)		const

inline

Parameters

[in]	inputs	the actual inputs
[in]	idx	which input group to retrieve

Returns: the input group based on internal configuration

◆ get_options()

struct pressio_options pressio_subgroup_manager::get_options ( ) const

inlineoverridevirtual

get a set of options available for the configurable object.

The compressor should set a value if they have been set as default The compressor should set a "reset" value if they are required to be set, but don't have a meaningful default

See also: pressio_compressor_get_options for the semantics this function should obey; pressio_options_clear to set a "reset" value; pressio_options_set_integer to set an integer value; pressio_options_set_double to set an double value; pressio_options_set_userptr to set an data value, include an include/ext/<my_plugin>.h to define the structure used; pressio_options_set_string to set a string value

Reimplemented from pressio_configurable.

◆ get_output_group()

template<class Span >

std::vector< pressio_data * > pressio_subgroup_manager::get_output_group	(	Span const &	inputs,
		int	idx
	)		const

inline

Parameters

[in]	inputs	the actual inputs
[in]	idx	which input group to retrieve

Returns: the input group based on internal configuration

◆ normalize_and_validate()

template<class U , class V >

int pressio_subgroup_manager::normalize_and_validate	(	compat::span< U > const &	inputs,
		compat::span< V > const &	outputs
	)

inline

makes the input and output groups match sizes and other sanity tests

Parameters

[in]	inputs	the inputs groups
[in]	outputs	the output groups

◆ prefix()

const char * pressio_subgroup_manager::prefix ( ) const

inlineoverridevirtual

get the prefix used by this compressor for options

Implements pressio_configurable.

◆ set_options()

int pressio_subgroup_manager::set_options ( const struct pressio_options & options )

inlineoverridevirtual

sets a set of options for the configurable object

Parameters

[in] options to set for configuration of the configurable object

See also: pressio_compressor_set_options for the semantics this function should obey

Reimplemented from pressio_configurable.

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

include/libpressio_ext/cpp/subgroup_manager.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ effective_input_groups()

◆ effective_output_groups()

◆ get_documentation()

◆ get_input_group()

◆ get_options()

◆ get_output_group()

◆ normalize_and_validate()

◆ prefix()

◆ set_options()