Class containing several options for the HODLR code and data-structures. More...

#include <HODLROptions.hpp>

Public Types
using	real_t = typename RealType< scalar_t >::value_type

Public Member Functions
	HODLROptions ()

void	set_rel_tol (real_t rel_tol)

void	set_abs_tol (real_t abs_tol)

void	set_leaf_size (int leaf_size)

void	set_max_rank (int max_rank)

void	set_rank_guess (int rank_guess)

void	set_rank_rate (double rank_rate)

void	set_clustering_algorithm (ClusteringAlgorithm a)

void	set_compression_algorithm (CompressionAlgorithm a)

void	set_butterfly_levels (int bfl)

void	set_BACA_block_size (int BACA)

void	set_BF_sampling_parameter (double param)

void	set_geo (int geo)

void	set_lr_leaf (int lr_leaf)

void	set_knn_hodlrbf (int k)

void	set_knn_lrbf (int k)

void	set_less_adapt (bool l)

void	set_verbose (bool verbose)

real_t	rel_tol () const

real_t	abs_tol () const

int	leaf_size () const

int	max_rank () const

int	rank_guess () const

double	rank_rate () const

ClusteringAlgorithm	clustering_algorithm () const

CompressionAlgorithm	compression_algorithm () const

int	butterfly_levels () const

int	BACA_block_size () const

double	BF_sampling_parameter () const

int	geo () const

int	lr_leaf () const

int	knn_hodlrbf () const

int	knn_lrbf () const

bool	less_adapt () const

bool	verbose () const

void	set_from_command_line (int argc, const char const cargv)

void	describe_options () const

Detailed Description

template<typename scalar_t>
class strumpack::HODLR::HODLROptions< scalar_t >

Class containing several options for the HODLR code and data-structures.

Template Parameters

scalar_t scalar type, can be float, double, std::complex<float> or std::complex<double>. This is used here mainly because tolerances might depend on the precision.

Member Typedef Documentation

◆ real_t

template<typename scalar_t >

using strumpack::HODLR::HODLROptions< scalar_t >::real_t = typename RealType<scalar_t>::value_type

real_t is the real type corresponding to the (possibly complex) scalar_t template parameter

Constructor & Destructor Documentation

◆ HODLROptions()

template<typename scalar_t >

strumpack::HODLR::HODLROptions< scalar_t >::HODLROptions ( )

inline

Default constructor, sets all options to their default values.

Member Function Documentation

◆ abs_tol()

template<typename scalar_t >

real_t strumpack::HODLR::HODLROptions< scalar_t >::abs_tol ( ) const

inline

Get the absolute compression tolerance.

Returns: the absolute compression tolerance

See also: set_abs_tol(), set_rel_tol(), get_rel_tol()

◆ BACA_block_size()

template<typename scalar_t >

int strumpack::HODLR::HODLROptions< scalar_t >::BACA_block_size ( ) const

inline

Get the BACA block size.

◆ BF_sampling_parameter()

template<typename scalar_t >

double strumpack::HODLR::HODLROptions< scalar_t >::BF_sampling_parameter ( ) const

inline

Get butterfly sampling parameter.

◆ butterfly_levels()

template<typename scalar_t >

int strumpack::HODLR::HODLROptions< scalar_t >::butterfly_levels ( ) const

inline

get the number of butterfly levels to use for each HODLR matrix.

◆ clustering_algorithm()

template<typename scalar_t >

ClusteringAlgorithm strumpack::HODLR::HODLROptions< scalar_t >::clustering_algorithm ( ) const

inline

Get the clustering algorithm to be used. This is used when constructing an HODLR approximation of a kernel matrix.

Returns: clustering algorithm

See also: set_clustering_algorithm

◆ compression_algorithm()

template<typename scalar_t >

CompressionAlgorithm strumpack::HODLR::HODLROptions< scalar_t >::compression_algorithm ( ) const

inline

Get the compression algorithm to be used.

Returns: compression algorithm

See also: set_compression_algorithm

◆ describe_options()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::describe_options ( ) const

Print an overview of the available command line options and their current values.

◆ geo()

template<typename scalar_t >

int strumpack::HODLR::HODLROptions< scalar_t >::geo ( ) const

inline

Use geometry information? 0, 1 or 2

◆ knn_hodlrbf()

template<typename scalar_t >

int strumpack::HODLR::HODLROptions< scalar_t >::knn_hodlrbf ( ) const

inline

The number of neighbors to use in the HODLR or HODBF construction.

◆ knn_lrbf()

template<typename scalar_t >

int strumpack::HODLR::HODLROptions< scalar_t >::knn_lrbf ( ) const

inline

The number of neighbors to use in the LR or Butterfly block construction.

◆ leaf_size()

template<typename scalar_t >

int strumpack::HODLR::HODLROptions< scalar_t >::leaf_size ( ) const

inline

Get the HODLR leaf size.

Returns: the (approximate) HODLR leaf size

See also: set_leaf_size()

◆ less_adapt()

template<typename scalar_t >

bool strumpack::HODLR::HODLROptions< scalar_t >::less_adapt ( ) const

inline

Returns whether or not to use less_adapt in the randomized construction algorithm.

◆ lr_leaf()

template<typename scalar_t >

int strumpack::HODLR::HODLROptions< scalar_t >::lr_leaf ( ) const

inline

Bottom level compression algorithms in H-BACA 1, 2, 3, 4, or 5

◆ max_rank()

template<typename scalar_t >

int strumpack::HODLR::HODLROptions< scalar_t >::max_rank ( ) const

inline

Get the maximum allowable rank (note, this is not the actual maximum computed rank).

Returns: maximum allowable rank

See also: set_max_rank()

◆ rank_guess()

template<typename scalar_t >

int strumpack::HODLR::HODLROptions< scalar_t >::rank_guess ( ) const

inline

Get the initial guess for the rank.

◆ rank_rate()

template<typename scalar_t >

double strumpack::HODLR::HODLROptions< scalar_t >::rank_rate ( ) const

inline

Get the rate of increment for adaptively determining the rank.

◆ rel_tol()

template<typename scalar_t >

real_t strumpack::HODLR::HODLROptions< scalar_t >::rel_tol ( ) const

inline

Get the relative compression tolerance.

Returns: the relative compression tolerance

See also: set_rel_tol(), set_abs_tol(), get_abs_tol()

◆ set_abs_tol()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_abs_tol ( real_t abs_tol )

inline

Set the absolute compression tolerance.

Parameters

abs_tol absolute compression tolerance

◆ set_BACA_block_size()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_BACA_block_size ( int BACA )

inline

Set the BACA block size.

◆ set_BF_sampling_parameter()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_BF_sampling_parameter ( double param )

inline

Set sampling parameter for use in linear complexity butterfly compression, higher for more robust sampling.

◆ set_butterfly_levels()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_butterfly_levels ( int bfl )

inline

Set the number of butterfly levels to use for each HODLR matrix.

◆ set_clustering_algorithm()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_clustering_algorithm ( ClusteringAlgorithm a )

inline

Specify the clustering algorithm. This is used when constructing a kernel matrix approximation.

◆ set_compression_algorithm()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_compression_algorithm ( CompressionAlgorithm a )

inline

Specify the compression algorithm to be used.

◆ set_from_command_line()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_from_command_line	(	int	argc,
		const char const	cargv
	)

Parse the command line options given by argc and argv. The options will not be modified. Run with –help to see an overview of available options, or call describe_options().

Parameters

argc	Number of elements in argv
argv	Array with options

◆ set_geo()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_geo ( int geo )

inline

geo should be 0, 1, 2 or 3. 0 means use point geometry, 1 means do not use any geometry. 2 means use the graph connectivity for the distance and admissibility info, 3 means use the graph to directly find closest neighbors.

◆ set_knn_hodlrbf()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_knn_hodlrbf ( int k )

inline

Set the number of neighbors to use in construction of the HODLR or HODBF matrices.

◆ set_knn_lrbf()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_knn_lrbf ( int k )

inline

Set the number of neighbors to use in construction of the LR or Butterfly blocks.

◆ set_leaf_size()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_leaf_size ( int leaf_size )

inline

Set the HODLR leaf size. The smallest diagonal blocks in the HODLR hierarchy will have size approximately the leaf size (within a factor 2).

Parameters

leaf_size

◆ set_less_adapt()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_less_adapt ( bool l )

inline

Enable/disable the less_adapt algorithm in randomized construction.

◆ set_lr_leaf()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_lr_leaf ( int lr_leaf )

inline

lr_leaf should be 1, 2, 3, 4, 5. 1 means svd, 2 means rrqr, 3 means baseline aca, 4 means baca original version, 5 means baca improved version.

◆ set_max_rank()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_max_rank ( int max_rank )

inline

Set the maximum rank allowed in HODLR compression.

◆ set_rank_guess()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_rank_guess ( int rank_guess )

inline

Set the initial guess for the rank.

◆ set_rank_rate()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_rank_rate ( double rank_rate )

inline

Set the rate of increment for adaptively determining the rank.

◆ set_rel_tol()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_rel_tol ( real_t rel_tol )

inline

Set the relative tolerance to be used for HODLR compression. Tuning this parameter is very important for performance.

Parameters

rel_tol relative compression tolerance

◆ set_verbose()

template<typename scalar_t >

void strumpack::HODLR::HODLROptions< scalar_t >::set_verbose ( bool verbose )

inline

Enable or disable verbose output (only by the root process) to stdout.

◆ verbose()

template<typename scalar_t >

bool strumpack::HODLR::HODLROptions< scalar_t >::verbose ( ) const

inline

Verbose or quiet?

Returns: True if we want output from the HODLR algorithms, else False.

See also: set_verbose

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

/home/pieterg/LBL/STRUMPACK/STRUMPACK/src/HODLR/HODLROptions.hpp

Public Types

Public Member Functions

Detailed Description

template<typename scalar_t> class strumpack::HODLR::HODLROptions< scalar_t >

Member Typedef Documentation

◆ real_t

Constructor & Destructor Documentation

◆ HODLROptions()

Member Function Documentation

◆ abs_tol()

◆ BACA_block_size()

◆ BF_sampling_parameter()

◆ butterfly_levels()

◆ clustering_algorithm()

◆ compression_algorithm()

◆ describe_options()

◆ geo()

◆ knn_hodlrbf()

◆ knn_lrbf()

◆ leaf_size()

◆ less_adapt()

◆ lr_leaf()

◆ max_rank()

◆ rank_guess()

◆ rank_rate()

◆ rel_tol()

◆ set_abs_tol()

◆ set_BACA_block_size()

◆ set_BF_sampling_parameter()

◆ set_butterfly_levels()

◆ set_clustering_algorithm()

◆ set_compression_algorithm()

◆ set_from_command_line()

◆ set_geo()

◆ set_knn_hodlrbf()

◆ set_knn_lrbf()

◆ set_leaf_size()

◆ set_less_adapt()

◆ set_lr_leaf()

◆ set_max_rank()

◆ set_rank_guess()

◆ set_rank_rate()

◆ set_rel_tol()

◆ set_verbose()

◆ verbose()

template<typename scalar_t>
class strumpack::HODLR::HODLROptions< scalar_t >