Sleipnir C++ API
Loading...
Searching...
No Matches
slp::Inertia Class Reference

#include </home/runner/work/Sleipnir/Sleipnir/include/sleipnir/optimization/solver/util/inertia.hpp>

Public Member Functions

constexpr Inertia (int positive, int negative, int zero)
 
bool operator== (const Inertia &) const =default
 

Public Attributes

int positive = 0
 The number of positive eigenvalues.
 
int negative = 0
 The number of negative eigenvalues.
 
int zero = 0
 The number of zero eigenvalues.
 

Detailed Description

Represents the inertia of a matrix (the number of positive, negative, and zero eigenvalues).

Constructor & Destructor Documentation

◆ Inertia()

constexpr slp::Inertia::Inertia ( int  positive,
int  negative,
int  zero 
)
inlineconstexpr

Constructs Inertia with the given number of positive, negative, and zero eigenvalues.

Parameters
positiveThe number of positive eigenvalues.
negativeThe number of negative eigenvalues.
zeroThe number of zero eigenvalues.

Member Function Documentation

◆ operator==()

bool slp::Inertia::operator== ( const Inertia &  ) const
default

Inertia equality operator.

Returns
True if Inertia is equal.

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