mlpack  2.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
lcc.hpp
Go to the documentation of this file.
1 
13 #ifndef MLPACK_METHODS_LOCAL_COORDINATE_CODING_LCC_HPP
14 #define MLPACK_METHODS_LOCAL_COORDINATE_CODING_LCC_HPP
15 
16 #include <mlpack/prereqs.hpp>
18 
19 // Include three simple dictionary initializers from sparse coding.
20 #include "../sparse_coding/nothing_initializer.hpp"
21 #include "../sparse_coding/data_dependent_random_initializer.hpp"
22 #include "../sparse_coding/random_initializer.hpp"
23 
24 namespace mlpack {
25 namespace lcc {
26 
80 {
81  public:
102  template<
103  typename DictionaryInitializer =
105  >
106  LocalCoordinateCoding(const arma::mat& data,
107  const size_t atoms,
108  const double lambda,
109  const size_t maxIterations = 0,
110  const double tolerance = 0.01,
111  const DictionaryInitializer& initializer =
112  DictionaryInitializer());
113 
125  LocalCoordinateCoding(const size_t atoms,
126  const double lambda,
127  const size_t maxIterations = 0,
128  const double tolerance = 0.01);
129 
138  template<
139  typename DictionaryInitializer =
141  >
142  void Train(const arma::mat& data,
143  const DictionaryInitializer& initializer =
144  DictionaryInitializer());
145 
152  void Encode(const arma::mat& data, arma::mat& codes);
153 
161  void OptimizeDictionary(const arma::mat& data,
162  const arma::mat& codes,
163  const arma::uvec& adjacencies);
164 
168  double Objective(const arma::mat& data,
169  const arma::mat& codes,
170  const arma::uvec& adjacencies) const;
171 
173  size_t Atoms() const { return atoms; }
175  size_t& Atoms() { return atoms; }
176 
178  const arma::mat& Dictionary() const { return dictionary; }
180  arma::mat& Dictionary() { return dictionary; }
181 
183  double Lambda() const { return lambda; }
185  double& Lambda() { return lambda; }
186 
188  size_t MaxIterations() const { return maxIterations; }
190  size_t& MaxIterations() { return maxIterations; }
191 
193  double Tolerance() const { return tolerance; }
195  double& Tolerance() { return tolerance; }
196 
198  template<typename Archive>
199  void Serialize(Archive& ar, const unsigned int /* version */);
200 
201  private:
203  size_t atoms;
204 
206  arma::mat dictionary;
207 
209  double lambda;
210 
212  size_t maxIterations;
214  double tolerance;
215 };
216 
217 } // namespace lcc
218 } // namespace mlpack
219 
220 // Include implementation.
221 #include "lcc_impl.hpp"
222 
223 #endif
double & Lambda()
Modify the L1 regularization parameter.
Definition: lcc.hpp:185
void Serialize(Archive &ar, const unsigned int)
Serialize the model.
double & Tolerance()
Modify the objective tolerance.
Definition: lcc.hpp:195
The core includes that mlpack expects; standard C++ includes and Armadillo.
void Encode(const arma::mat &data, arma::mat &codes)
Code each point via distance-weighted LARS.
size_t & Atoms()
Modify the number of atoms.
Definition: lcc.hpp:175
double Lambda() const
Get the L1 regularization parameter.
Definition: lcc.hpp:183
A data-dependent random dictionary initializer for SparseCoding.
arma::mat & Dictionary()
Mutator for dictionary.
Definition: lcc.hpp:180
void Train(const arma::mat &data, const DictionaryInitializer &initializer=DictionaryInitializer())
Run local coordinate coding.
size_t MaxIterations() const
Get the maximum number of iterations.
Definition: lcc.hpp:188
An implementation of Local Coordinate Coding (LCC) that codes data which approximately lives on a man...
Definition: lcc.hpp:79
double Objective(const arma::mat &data, const arma::mat &codes, const arma::uvec &adjacencies) const
Compute objective function given the list of adjacencies.
void OptimizeDictionary(const arma::mat &data, const arma::mat &codes, const arma::uvec &adjacencies)
Learn dictionary by solving linear system.
const arma::mat & Dictionary() const
Accessor for dictionary.
Definition: lcc.hpp:178
size_t Atoms() const
Get the number of atoms.
Definition: lcc.hpp:173
double Tolerance() const
Get the objective tolerance.
Definition: lcc.hpp:193
size_t & MaxIterations()
Modify the maximum number of iterations.
Definition: lcc.hpp:190
LocalCoordinateCoding(const arma::mat &data, const size_t atoms, const double lambda, const size_t maxIterations=0, const double tolerance=0.01, const DictionaryInitializer &initializer=DictionaryInitializer())
Set the parameters to LocalCoordinateCoding, and train the dictionary.