[mlpack-svn] [MLPACK] #154: Use new naming conventions for all MLPACK classes

MLPACK Trac trac at coffeetalk-1.cc.gatech.edu
Wed Oct 26 19:20:13 EDT 2011


#154: Use new naming conventions for all MLPACK classes
----------------------+-----------------------------------------------------
 Reporter:  rcurtin   |        Owner:                                         
     Type:  task      |       Status:  new                                    
 Priority:  critical  |    Milestone:  MLPACK 1.0                             
Component:  MLPACK    |     Keywords:  camelcase classes formatting style code
 Blocking:  150       |   Blocked By:                                         
----------------------+-----------------------------------------------------
 Variable names should be declared in camelcase, starting with a lowercase
 letter:

 {{{
 int leafSize;
 int dim;
 int newDim;
 }}}

 The names of the accessors and mutators for these variables should have
 the following format:

 {{{
 int leafSize;

 const int LeafSize() const;
 void LeafSize(const int leafSize);

 arma::mat someMatrix;

 const arma::mat& SomeMatrix() const;
 void SomeMatrix(const arma::mat& SomeMatrix);
 }}}

 Method names should start with an uppercase letter and also be camelcase.

-- 
Ticket URL: <http://trac.research.cc.gatech.edu/fastlab/ticket/154>
MLPACK <www.fast-lab.org>
MLPACK is an intuitive, fast, and scalable C++ machine learning library developed by the FASTLAB at Georgia Tech under Dr. Alex Gray.


More information about the mlpack-svn mailing list