Kernel Quantum Probability Library
The KQP library aims at providing tools for working with quantums probabilities
Public Member Functions
kqp::RankSelector< Scalar, byMagnitude > Class Template Reference

Select the highest eigenvalues (with a possible "reset" rank) More...

#include <rank_selector.hpp>

Inheritance diagram for kqp::RankSelector< Scalar, byMagnitude >:
kqp::Selector< Scalar >

Public Member Functions

 RankSelector (Index maxRank)
 
 RankSelector (Index maxRank, Index resetRank)
 
void selection (EigenList< Scalar > &eigenvalues) const override
 
virtual picojson::object save () const
 

Detailed Description

template<typename Scalar, bool byMagnitude>
class kqp::RankSelector< Scalar, byMagnitude >

Select the highest eigenvalues (with a possible "reset" rank)

Constructor & Destructor Documentation

template<typename Scalar , bool byMagnitude>
kqp::RankSelector< Scalar, byMagnitude >::RankSelector ( Index  maxRank)
inline

Selects the highest eigenvalues (either magnitude or values)

Parameters
rankThe maximum and selected rank
byMagnitudeIf true, then eigenvalues will be sorted by absolute value
template<typename Scalar , bool byMagnitude>
kqp::RankSelector< Scalar, byMagnitude >::RankSelector ( Index  maxRank,
Index  resetRank 
)
inline

Construct a selector that uses a reset rank

Member Function Documentation

template<typename Scalar , bool byMagnitude>
virtual picojson::object kqp::RankSelector< Scalar, byMagnitude >::save ( ) const
inlinevirtual

Saves the selector to JSON

Implements kqp::Selector< Scalar >.

template<typename Scalar , bool byMagnitude>
void kqp::RankSelector< Scalar, byMagnitude >::selection ( EigenList< Scalar > &  eigenvalues) const
inlineoverridevirtual
Parameters
eigenValuesThe ordered list of eigenvalues

Implements kqp::Selector< Scalar >.


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