![]() |
slope 0.31.0
|
Container class for SLOPE regression solution paths. More...
#include <slope_path.h>
Public Member Functions | |
SlopePath ()=default | |
Constructs an empty SlopePath object. | |
SlopePath (const std::vector< SlopeFit > &fits) | |
Constructs a SlopePath object containing SLOPE regression solution path data. | |
const SlopeFit & | operator() (const size_t step) const |
Get one of the coefficients along the path. | |
std::vector< Eigen::VectorXd > | getIntercepts (const bool original_scale=true) const |
Returns the vector of intercept terms for each solution in the path. | |
std::vector< Eigen::SparseMatrix< double > > | getCoefs (const bool original_scale=true) const |
Returns the vector of coefficient matrices for each solution in the path. | |
std::vector< Clusters > | getClusters () const |
Returns the clusters for each solution in the path. | |
Eigen::ArrayXd | getAlpha () const |
Gets the alpha parameter sequence. | |
const Eigen::ArrayXd & | getLambda () const |
Gets the lambda (regularization) weights. | |
std::vector< double > | getDeviance () const |
Gets the deviance values for each solution. | |
double | getNullDeviance () const |
Gets the null model deviance. | |
std::vector< std::vector< double > > | getPrimals () const |
Gets the primal objective values during optimization. | |
std::vector< std::vector< double > > | getDuals () const |
Gets the dual objective values during optimization. | |
std::vector< std::vector< double > > | getTime () const |
Gets the computation times for each solution. | |
std::vector< int > | getPasses () const |
Gets the number of iterations for each solution. | |
const std::vector< double > | getDevianceRatios () const |
Computes the deviance ratio (explained deviance) for each solution. | |
std::vector< std::vector< double > > | getGaps () const |
Computes the duality gaps (primal - dual objectives) for each solution. | |
std::size_t | size () const |
Gets the number of solutions in the path. | |
Container class for SLOPE regression solution paths.
Stores a path of SlopeFit objects and provides convenience access to:
Definition at line 30 of file slope_path.h.
|
inline |
Constructs a SlopePath object containing SLOPE regression solution path data.
fits | Vector of SlopeFit objects for each solution in the path |
Definition at line 47 of file slope_path.h.
|
inline |
Gets the alpha parameter sequence.
Definition at line 127 of file slope_path.h.
|
inline |
Returns the clusters for each solution in the path.
Definition at line 113 of file slope_path.h.
|
inline |
Returns the vector of coefficient matrices for each solution in the path.
Each element in the returned vector is a sparse matrix containing the model coefficients for a particular solution in the regularization path.
Definition at line 96 of file slope_path.h.
|
inline |
Gets the deviance values for each solution.
Definition at line 147 of file slope_path.h.
|
inline |
Computes the deviance ratio (explained deviance) for each solution.
Definition at line 224 of file slope_path.h.
|
inline |
Gets the dual objective values during optimization.
Definition at line 180 of file slope_path.h.
|
inline |
Computes the duality gaps (primal - dual objectives) for each solution.
Definition at line 240 of file slope_path.h.
|
inline |
Returns the vector of intercept terms for each solution in the path.
Each element in the returned vector corresponds to the intercept term(s) for a particular solution in the regularization path.
Definition at line 74 of file slope_path.h.
|
inline |
Gets the lambda (regularization) weights.
Definition at line 142 of file slope_path.h.
|
inline |
Gets the null model deviance.
Definition at line 161 of file slope_path.h.
|
inline |
Gets the number of iterations for each solution.
Definition at line 208 of file slope_path.h.
|
inline |
Gets the primal objective values during optimization.
Definition at line 166 of file slope_path.h.
|
inline |
Gets the computation times for each solution.
Definition at line 194 of file slope_path.h.
|
inline |
Get one of the coefficients along the path.
step | the |
step
of the path. A SlopeFit object. Definition at line 58 of file slope_path.h.
|
inline |
Gets the number of solutions in the path.
Definition at line 255 of file slope_path.h.