.TH "mlpack::gmm::EigenvalueRatioConstraint" 3 "Tue Sep 9 2014" "Version 1.0.10" "MLPACK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mlpack::gmm::EigenvalueRatioConstraint \- 
.PP
Given a vector of eigenvalue ratios, ensure that the covariance matrix always has those eigenvalue ratios\&.  

.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBEigenvalueRatioConstraint\fP (const arma::vec &\fBratios\fP)"
.br
.RI "\fICreate the \fBEigenvalueRatioConstraint\fP object with the given vector of eigenvalue ratios\&. \fP"
.ti -1c
.RI "void \fBApplyConstraint\fP (arma::mat &covariance) const "
.br
.RI "\fIApply the eigenvalue ratio constraint to the given covariance matrix\&. \fP"
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "const arma::vec & \fBratios\fP"
.br
.RI "\fIRatios for eigenvalues\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Given a vector of eigenvalue ratios, ensure that the covariance matrix always has those eigenvalue ratios\&. 

When you create this object, make sure that the vector of ratios that you pass does not go out of scope, because this object holds a reference to that vector instead of copying it\&. 
.PP
Definition at line 36 of file eigenvalue_ratio_constraint\&.hpp\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "mlpack::gmm::EigenvalueRatioConstraint::EigenvalueRatioConstraint (const arma::vec &ratios)\fC [inline]\fP"

.PP
Create the \fBEigenvalueRatioConstraint\fP object with the given vector of eigenvalue ratios\&. These ratios are with respect to the first eigenvalue, which is the largest eigenvalue, so the first element of the vector should be 1\&. In addition, all other elements should be less than or equal to 1\&. 
.PP
Definition at line 45 of file eigenvalue_ratio_constraint\&.hpp\&.
.PP
References mlpack::Log::Fatal, and mlpack::Log::Warn\&.
.SH "Member Function Documentation"
.PP 
.SS "void mlpack::gmm::EigenvalueRatioConstraint::ApplyConstraint (arma::mat &covariance) const\fC [inline]\fP"

.PP
Apply the eigenvalue ratio constraint to the given covariance matrix\&. 
.PP
Definition at line 70 of file eigenvalue_ratio_constraint\&.hpp\&.
.PP
References ratios\&.
.SH "Member Data Documentation"
.PP 
.SS "const arma::vec& mlpack::gmm::EigenvalueRatioConstraint::ratios\fC [private]\fP"

.PP
Ratios for eigenvalues\&. 
.PP
Definition at line 89 of file eigenvalue_ratio_constraint\&.hpp\&.
.PP
Referenced by ApplyConstraint()\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MLPACK from the source code\&.