#include <deal.II/lac/matrix_scaling.h>

Detailed Description

Struct that contains parameters for the Sinkhorn-Knopp algorithm.

Definition at line 113 of file matrix_scaling.h.

Public Types
enum class	NormType { l1 , l_infty }

Public Member Functions
	SKParameters (const NormType norm_type=NormType::l1, const unsigned int max_iterations=20)

Public Attributes
unsigned int	max_iterations

NormType	norm_type

Member Enumeration Documentation

◆ NormType

enum class MatrixScaling::AdditionalData::SKParameters::NormType

strong

Scaling norm available to use in the Sinkhorn-Knopp algorithm. By setting this parameter the SK algorithm alternatingly scales rows and column using the selected vector norm type.

Enumerator
l1	l_1 vector norm
l_infty	l_infinity vector norm

Definition at line 120 of file matrix_scaling.h.

Constructor & Destructor Documentation

◆ SKParameters()

MatrixScaling::AdditionalData::SKParameters::SKParameters	(	const NormType	norm_type = `NormType::l1`,
		const unsigned int	max_iterations = `20`
	)

explicit

Construct a new SKParameters object with the given parameters.

Definition at line 58 of file matrix_scaling.cc.

Member Data Documentation

◆ max_iterations

unsigned int MatrixScaling::AdditionalData::SKParameters::max_iterations

Maximum number of iterations to perform in the SK algorithm.

Definition at line 138 of file matrix_scaling.h.

◆ norm_type

NormType MatrixScaling::AdditionalData::SKParameters::norm_type

Norm type to use in the SK algorithm.

Definition at line 143 of file matrix_scaling.h.

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

include/deal.II/lac/matrix_scaling.h
source/lac/matrix_scaling.cc