diff --git a/src/classification/ConvexHull1D.cpp b/src/classification/ConvexHull1D.cpp index e370578bbae55381f7ea72698f2589afbb3ec492..7db3166ce8271f79bc3249b95c05e4e405d499d4 100644 --- a/src/classification/ConvexHull1D.cpp +++ b/src/classification/ConvexHull1D.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file classification/ConvexHull1D.cpp + * @brief Implements a class that calculates the 1D Convex Hull overlap of a vector with property labels + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "classification/ConvexHull1D.hpp" ConvexHull1D::ConvexHull1D() : diff --git a/src/classification/ConvexHull1D.hpp b/src/classification/ConvexHull1D.hpp index 8d04afef2f978945ff77389d759160c655d1f917..310dfa533540b393480f07bdc8590580b667988b 100644 --- a/src/classification/ConvexHull1D.hpp +++ b/src/classification/ConvexHull1D.hpp @@ -27,6 +27,10 @@ #include "classification/prop_sorted_d_mat.hpp" #include "utils/math_funcs.hpp" +// DocString: cls_convex_hull_1d +/** + * @brief Calculates the 1D convex hull overlap between a vector with property labels + */ class ConvexHull1D { protected : diff --git a/src/classification/LPWrapper.cpp b/src/classification/LPWrapper.cpp index 996f31813feb6262f8b24f3f98db732c693befd0..9f1852748bad946a872ba2a99d3cd1a5d0e52115 100644 --- a/src/classification/LPWrapper.cpp +++ b/src/classification/LPWrapper.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file classification/LPWrapper.cpp + * @brief Implements a class used to wrap the Coin-Clp Simplex Library, and facilitate its use with SISSO++ + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "classification/LPWrapper.hpp" #include <iomanip> LPWrapper::LPWrapper( diff --git a/src/classification/LPWrapper.hpp b/src/classification/LPWrapper.hpp index 2e72dee0686a4f4309a12dcfdc795d7b3fe98764..be4c449fd65ea8f441845a3ae559e72bd0b40053 100644 --- a/src/classification/LPWrapper.hpp +++ b/src/classification/LPWrapper.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file classification/LPWrapper.hpp - * @brief A class used to wrap the Coin-Clp Simplex Library, and facilitate its use with SISSO++ + * @brief Defines a class used to wrap the Coin-Clp Simplex Library, and facilitate its use with SISSO++ * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. @@ -28,6 +28,11 @@ #include "classification/prop_sorted_d_mat.hpp" #include "utils/mkl_interface.hpp" + +// DocString: cls_lp_wrapper +/** + * @brief A wrapper to the ClpSimplex library to facilitate use with SISSO++ + */ class LPWrapper { protected: diff --git a/src/classification/SVMWrapper.cpp b/src/classification/SVMWrapper.cpp index e69b40f00bb72d57d8f21ed33f4e278539261998..c62386ffea3d3dc2d73b4c195b5493ab40aa777c 100644 --- a/src/classification/SVMWrapper.cpp +++ b/src/classification/SVMWrapper.cpp @@ -12,6 +12,13 @@ // See the License for the specific language governing permissions and // limitations under the License. +/** @file classification/SVMWrapper.cpp + * @brief Implements a class used to wrap libsvm in more C++ oriented data structure + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "classification/SVMWrapper.hpp" SVMWrapper::SVMWrapper(const int n_class, const int n_dim, const int n_samp, const double* prop) : diff --git a/src/classification/SVMWrapper.hpp b/src/classification/SVMWrapper.hpp index fe0524b0f697399f9a31f6a04bdeed8e7ce432cf..3555d04d84e5fb5c75fbd9ed43267f91460dfc9e 100644 --- a/src/classification/SVMWrapper.hpp +++ b/src/classification/SVMWrapper.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file classification/SVMWrapper.hpp - * @brief A class used to wrap libsvm in more C++ oriented data structure + * @brief Defines a class used to wrap libsvm in more C++ oriented data structure * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. @@ -28,6 +28,11 @@ #include "classification/prop_sorted_d_mat.hpp" #include "external/libsvm/svm.h" +// DocString: cls_svm_wrapper +/** + * @brief Wrapper for libSVM that uses more C++ friendly data structures + * + */ class SVMWrapper { protected: diff --git a/src/classification/prop_sorted_d_mat.cpp b/src/classification/prop_sorted_d_mat.cpp index 1328e7d0ba50722618d211dd84a5ef656cb4550c..386ca307f8e491723476337b54f6083490d87821 100644 --- a/src/classification/prop_sorted_d_mat.cpp +++ b/src/classification/prop_sorted_d_mat.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file classification/prop_sorted_d_mat.cpp + * @brief Implements the functions for the central storage area for a sorted descriptor matrix based on the task/class of a sample + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "classification/prop_sorted_d_mat.hpp" std::vector<double> prop_sorted_d_mat::SORTED_D_MATRIX; diff --git a/src/descriptor_identifier/model/Model.cpp b/src/descriptor_identifier/model/Model.cpp index bc55527f26cef3c64434153c0513a4cea96f0e23..9b12a9c63398cc5f12b63a1fb1554e672566c3f6 100644 --- a/src/descriptor_identifier/model/Model.cpp +++ b/src/descriptor_identifier/model/Model.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file descriptor_identifier/model/Model.cpp + * @brief Implements the base class of the output Models for SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/model/Model.hpp" Model::Model( diff --git a/src/descriptor_identifier/model/Model.hpp b/src/descriptor_identifier/model/Model.hpp index 1847bf12333b52d9105f6b800a60dfdf3fac99d4..61a1e0c1d4898f1285a1c769d507c97fc15ece4a 100644 --- a/src/descriptor_identifier/model/Model.hpp +++ b/src/descriptor_identifier/model/Model.hpp @@ -36,7 +36,7 @@ // DocString: cls_model /** - * @brief Class to store the models found from SISSO + * @brief Base class to store the output models from SISSO * */ class Model diff --git a/src/descriptor_identifier/model/ModelClassifier.cpp b/src/descriptor_identifier/model/ModelClassifier.cpp index 94895e49242e21da6b074811fc93f310e3cd69f4..480c04fcb52aa22570e93daaa09ddcb496f4ea4a 100644 --- a/src/descriptor_identifier/model/ModelClassifier.cpp +++ b/src/descriptor_identifier/model/ModelClassifier.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file descriptor_identifier/model/ModelClassifier.cpp + * @brief Implements a class for the output models from solving a classification problem + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/model/ModelClassifier.hpp" ModelClassifier::ModelClassifier( diff --git a/src/descriptor_identifier/model/ModelClassifier.hpp b/src/descriptor_identifier/model/ModelClassifier.hpp index 94baf348cb99675cf7755f5d8dd8b22fc61e3a2a..fe29e171c52f5929fe3177b5c85effa8ca3d5b31 100644 --- a/src/descriptor_identifier/model/ModelClassifier.hpp +++ b/src/descriptor_identifier/model/ModelClassifier.hpp @@ -31,7 +31,7 @@ // DocString: cls_model_class /** - * @brief Class to store the models found from SISSO + * @brief Class to store the output models from SISSOClassifier * */ class ModelClassifier : public Model diff --git a/src/descriptor_identifier/model/ModelLogRegressor.cpp b/src/descriptor_identifier/model/ModelLogRegressor.cpp index 5bb4703ddfa227cdbc034bad2918543e8c2b05e1..6bec56f6c4afbbccfafbdf7b1ee7f6d0483f1ee5 100644 --- a/src/descriptor_identifier/model/ModelLogRegressor.cpp +++ b/src/descriptor_identifier/model/ModelLogRegressor.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file descriptor_identifier/model/ModelLogRegressor.cpp + * @brief Implements a class for the output models from solving a log regression problem + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/model/ModelLogRegressor.hpp" ModelLogRegressor::ModelLogRegressor() diff --git a/src/descriptor_identifier/model/ModelLogRegressor.hpp b/src/descriptor_identifier/model/ModelLogRegressor.hpp index 8b94934c08ad8948199ed6dec2dfc071f584dcf0..1f6bce56ae9d7ade66a0d5c8792bfcdf18679494 100644 --- a/src/descriptor_identifier/model/ModelLogRegressor.hpp +++ b/src/descriptor_identifier/model/ModelLogRegressor.hpp @@ -29,9 +29,9 @@ namespace py = boost::python; #endif -// DocString: cls_model_reg +// DocString: cls_model_log_reg /** - * @brief Class to store the models found from SISSO + * @brief Class to store the output models from SISSOLogRegressor * */ class ModelLogRegressor : public ModelRegressor diff --git a/src/descriptor_identifier/model/ModelRegressor.cpp b/src/descriptor_identifier/model/ModelRegressor.cpp index a528498a1a66475b13317f640838856c79b1f703..fd7de70aa599b7a4d44321460bae1403aa49d87d 100644 --- a/src/descriptor_identifier/model/ModelRegressor.cpp +++ b/src/descriptor_identifier/model/ModelRegressor.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file descriptor_identifier/model/ModelRegressor.cpp + * @brief Implements a class for the output models from solving a regression problem + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/model/ModelRegressor.hpp" ModelRegressor::ModelRegressor() diff --git a/src/descriptor_identifier/model/ModelRegressor.hpp b/src/descriptor_identifier/model/ModelRegressor.hpp index 753a4c66e8fc83228e88fb149cffd3d4d54fccbe..af3863566bb93f56be37139d6b86f46ce7870e43 100644 --- a/src/descriptor_identifier/model/ModelRegressor.hpp +++ b/src/descriptor_identifier/model/ModelRegressor.hpp @@ -31,7 +31,7 @@ // DocString: cls_model_reg /** - * @brief Class to store the models found from SISSO + * @brief Class to store the output models from SISSORegressor * */ class ModelRegressor : public Model diff --git a/src/descriptor_identifier/solver/SISSOClassifier.cpp b/src/descriptor_identifier/solver/SISSOClassifier.cpp index 68a9e529f99781e756f901de2913d6f094777fad..5aabb1370bb3498d0636d3823b726ff9f43bc9ae 100644 --- a/src/descriptor_identifier/solver/SISSOClassifier.cpp +++ b/src/descriptor_identifier/solver/SISSOClassifier.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file descriptor_identifier/SISSOClassifier.cpp + * @brief Implements a class for solving classification problems with SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/solver/SISSOClassifier.hpp" SISSOClassifier::SISSOClassifier( diff --git a/src/descriptor_identifier/solver/SISSOClassifier.hpp b/src/descriptor_identifier/solver/SISSOClassifier.hpp index c54eb98cae9cccd061f987594e1848cc1911cce3..65a8133ddda2cc4689bd87453bd3bde14570797b 100644 --- a/src/descriptor_identifier/solver/SISSOClassifier.hpp +++ b/src/descriptor_identifier/solver/SISSOClassifier.hpp @@ -35,7 +35,7 @@ // DocString: cls_sisso_class /** - * @brief SISSO Classifier class, performs the SISSO algorithm and stores all selected models + * @brief Uses SISSO to solve a classification problem * */ class SISSOClassifier: public SISSOSolver diff --git a/src/descriptor_identifier/solver/SISSOLogRegressor.cpp b/src/descriptor_identifier/solver/SISSOLogRegressor.cpp index 438ff9d341146b842fb8be9f6969f65292fe0aff..edae0d8f1d04119872639ed6254cc15e4de9bd80 100644 --- a/src/descriptor_identifier/solver/SISSOLogRegressor.cpp +++ b/src/descriptor_identifier/solver/SISSOLogRegressor.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file descriptor_identifier/SISSOLogRegressor.cpp + * @brief Implements a class for solving logarithmic regression problems with SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/solver/SISSOLogRegressor.hpp" SISSOLogRegressor::SISSOLogRegressor( diff --git a/src/descriptor_identifier/solver/SISSOLogRegressor.hpp b/src/descriptor_identifier/solver/SISSOLogRegressor.hpp index 6eca36d3cb2581cd97734b44ff1b0a896b4a52da..185bca0642f7f4ca304c08897a70b7fce0542fb4 100644 --- a/src/descriptor_identifier/solver/SISSOLogRegressor.hpp +++ b/src/descriptor_identifier/solver/SISSOLogRegressor.hpp @@ -32,7 +32,7 @@ // DocString: cls_sisso_log_reg /** - * @brief SISSO Regressor class, performs the SISSO algorithm and stores all selected models + * @brief Uses SISSO to solve a log regression problem * */ class SISSOLogRegressor: public SISSORegressor diff --git a/src/descriptor_identifier/solver/SISSORegressor.cpp b/src/descriptor_identifier/solver/SISSORegressor.cpp index d33d91ffde0870c983e404d1245e3bc9a50bfea8..77c3464d6e9fd4c839e96534b1335f383ea26ae7 100644 --- a/src/descriptor_identifier/solver/SISSORegressor.cpp +++ b/src/descriptor_identifier/solver/SISSORegressor.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file descriptor_identifier/SISSORegressor.cpp + * @brief Implements a class to solve regression problems with SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/solver/SISSORegressor.hpp" SISSORegressor::SISSORegressor( diff --git a/src/descriptor_identifier/solver/SISSORegressor.hpp b/src/descriptor_identifier/solver/SISSORegressor.hpp index 9ac8edf2a6cc8e17b2e11817a92e82ded1ef37fa..cd14fdf3cbe75ea79eab38721cfbc4d8c17ce829 100644 --- a/src/descriptor_identifier/solver/SISSORegressor.hpp +++ b/src/descriptor_identifier/solver/SISSORegressor.hpp @@ -32,7 +32,7 @@ // DocString: cls_sisso_reg /** - * @brief SISSO Regressor class, performs the SISSO algorithm and stores all selected models + * @brief Uses SISSO to solve a regression problem * */ class SISSORegressor: public SISSOSolver diff --git a/src/descriptor_identifier/solver/SISSOSolver.cpp b/src/descriptor_identifier/solver/SISSOSolver.cpp index 3cbadfca5ef9ddbf74062a182503499a30289ba4..caf7d582bf2ecb49782514ef46bc7882a37c37e3 100644 --- a/src/descriptor_identifier/solver/SISSOSolver.cpp +++ b/src/descriptor_identifier/solver/SISSOSolver.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file descriptor_identifier/solver/SISSOSolver.cpp + * @brief Implements the base class for creating solvers using SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/solver/SISSOSolver.hpp" SISSOSolver::SISSOSolver( diff --git a/src/descriptor_identifier/solver/SISSOSolver.hpp b/src/descriptor_identifier/solver/SISSOSolver.hpp index 03e581a54c10f6c524f53df778bb111c6244c57d..938db8f4d7655b2ce301fa8858cdd2d075815d8b 100644 --- a/src/descriptor_identifier/solver/SISSOSolver.hpp +++ b/src/descriptor_identifier/solver/SISSOSolver.hpp @@ -30,9 +30,9 @@ namespace py = boost::python; #endif -// DocString: cls_sisso_reg +// DocString: cls_sisso /** - * @brief SISSO Regressor class, performs the SISSO algorithm and stores all selected models + * @brief Base class for SISSO solvers * */ class SISSOSolver diff --git a/src/feature_creation/feature_space/FeatureSpace.cpp b/src/feature_creation/feature_space/FeatureSpace.cpp index 663131c5641996c941be05001b13c40f87ca2fba..3189808ec528be32f107422af320448f5e903239 100644 --- a/src/feature_creation/feature_space/FeatureSpace.cpp +++ b/src/feature_creation/feature_space/FeatureSpace.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/feature_space/FeatureSpace.cpp + * @brief Implements the class for creating/operating on a feature space in SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/feature_space/FeatureSpace.hpp" BOOST_CLASS_EXPORT_GUID(FeatureNode, "FeatureNode") diff --git a/src/feature_creation/feature_space/FeatureSpace.hpp b/src/feature_creation/feature_space/FeatureSpace.hpp index b4dae509702d565a26dc629dc0270edb3ec61132..43d8bd9c6138098a4e318a82f8495bf30e745582 100644 --- a/src/feature_creation/feature_space/FeatureSpace.hpp +++ b/src/feature_creation/feature_space/FeatureSpace.hpp @@ -41,8 +41,7 @@ // DocString: cls_feat_space /** - * @brief Feature Space for SISSO calculations - * @details Stores and performs all feature calculations for SIS + * @brief Feature Space for SISSO calculations. It stores and performs all actions on the feature space for SISSO. * */ class FeatureSpace diff --git a/src/feature_creation/node/FeatureNode.cpp b/src/feature_creation/node/FeatureNode.cpp index 5453b9e9f7e8ca15a747803e69c3a46312353639..4422d0f02a8ab9f797a173aab3010a3c50a86054 100644 --- a/src/feature_creation/node/FeatureNode.cpp +++ b/src/feature_creation/node/FeatureNode.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/FeatureNode.cpp + * @brief Implements the class that represent the primary features in SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the leaves of all of the binary expression trees. + */ + #include "feature_creation/node/FeatureNode.hpp" FeatureNode::FeatureNode() diff --git a/src/feature_creation/node/FeatureNode.hpp b/src/feature_creation/node/FeatureNode.hpp index b54499e55c10a9ee8ea9c86d932564ec73567487..959344d7cf37538d26802792f04f7f6a52b202de 100644 --- a/src/feature_creation/node/FeatureNode.hpp +++ b/src/feature_creation/node/FeatureNode.hpp @@ -36,7 +36,7 @@ namespace py = boost::python; // DocString: cls_feat_node /** - * @brief Node that describe the leaves of the operator graph (Initial features in Phi_0) + * @brief Node that describe the leaves of the operator graph (Primary features in Phi_0) */ class FeatureNode: public Node { diff --git a/src/feature_creation/node/ModelNode.cpp b/src/feature_creation/node/ModelNode.cpp index b72010520db5db26e6e14a1a6e51e6c95da47c0c..8ba7edc4076fece8c33f8b44d488f88922df832b 100644 --- a/src/feature_creation/node/ModelNode.cpp +++ b/src/feature_creation/node/ModelNode.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/ModelNode.cpp + * @brief Implements the class used to transfer features (Nodes) to the Model objects + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/node/ModelNode.hpp" ModelNode::ModelNode() diff --git a/src/feature_creation/node/ModelNode.hpp b/src/feature_creation/node/ModelNode.hpp index d335c3ee72cf11e8371f628e7ce467962c505f8d..a5c03120f09878d8f9d3f6c78095e56181b18d64 100644 --- a/src/feature_creation/node/ModelNode.hpp +++ b/src/feature_creation/node/ModelNode.hpp @@ -29,9 +29,10 @@ #include "feature_creation/node/operator_nodes/functions.hpp" typedef std::pair<std::function<void(int, std::vector<double*>&)>, int> fxn_nterms_pair; + // DocString: cls_model_node /** - * @brief Node that describe the leaves of the operator graph (Initial features in Phi_0) + * @brief Nodes that are used to describe the features passed to a Model */ class ModelNode: public FeatureNode { diff --git a/src/feature_creation/node/Node.cpp b/src/feature_creation/node/Node.cpp index 9fa6a13939cdc4abb9e7f4209726bdd44f465bfa..7b4749e214019a9002b3966fe6de7de49622b608 100644 --- a/src/feature_creation/node/Node.cpp +++ b/src/feature_creation/node/Node.cpp @@ -11,6 +11,18 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/Node.cpp + * @brief Implements the base class for the objects that represent features + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This package represents the features in SISSO as a binary expression tree and are accessible from the root node of that tree. + * The node class are the vertices of the tree and represent initial features (FeatureNode) and all algebraic operators (OperatorNodes). + * The edges are the represented via the _feats member in OperatorNode that store the features the operation acts on (its children). + */ + #include "feature_creation/node/Node.hpp" Node::Node() diff --git a/src/feature_creation/node/Node.hpp b/src/feature_creation/node/Node.hpp index 81040648207b246f6d8dc92d1e0afa078fb58dc4..c532b3d317422fd2280ce96098fb5a0a85af6196 100644 --- a/src/feature_creation/node/Node.hpp +++ b/src/feature_creation/node/Node.hpp @@ -44,8 +44,8 @@ class NLOptimizer; // DocString: cls_node /** - * @brief Base class for a Node - * @details Class used to describe a Node on the feature graph. Features are treated as an operation graph, these are the nodes on that graph. + * @brief Base class for a Node. + * @details The class is used to describe a Node on a binary expression tree. Features defined as the root of the binary expression tree. * */ class Node diff --git a/src/feature_creation/node/operator_nodes/OperatorNode.cpp b/src/feature_creation/node/operator_nodes/OperatorNode.cpp index e5e9d2da80d17d48103c5cbf90d5c939a1a245e4..d76799d469487e8bd1a01f2ccfb803470450198d 100644 --- a/src/feature_creation/node/operator_nodes/OperatorNode.cpp +++ b/src/feature_creation/node/operator_nodes/OperatorNode.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/OperatorNode.cpp + * @brief calls a Boost Serialization macro + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/node/operator_nodes/OperatorNode.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(OperatorNode) diff --git a/src/feature_creation/node/operator_nodes/OperatorNode.hpp b/src/feature_creation/node/operator_nodes/OperatorNode.hpp index 08f398a2e739b55ceeffde493e0c411777d054e4..2604659472e0cb25b7f952e4bee0b858be3daffd 100644 --- a/src/feature_creation/node/operator_nodes/OperatorNode.hpp +++ b/src/feature_creation/node/operator_nodes/OperatorNode.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file feature_creation/node/operator_nodes/OperatorNode.hpp - * @brief Defines the base class that represent all of the analytical operators in the Binary Expression Tree + * @brief Defines and Implements the base class that represent all of the analytical operators in the Binary Expression Tree * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. @@ -47,8 +47,7 @@ namespace np = boost::python::numpy; // DocString: cls_op_node /** - * @brief Base class to describe operator nodes - * @details Define the base features of all operator nodes + * @brief Base class to describe the operations in the binary expression tree (all non-leaf nodes) * * @tparam N Number of features the operator acts on (number of edges the vertex has) */ diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/absolute_value.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/absolute_value.cpp index d63a154b4f8dca47f46c830660c59a5b7617ffb1..985834b74326e98cf444936e0dd984ea1224f247 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/absolute_value.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/absolute_value.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/absolute_value.cpp + * @brief Implements a class for the absolute value operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> |A| + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/abs/absolute_value.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(AbsNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.cpp index 5b4d2a630d08401d97af37a4711b1931234a2f9e..c8d6f19202390c78adee2c28a66a50928e498e5d 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.cpp + * @brief Implements a class for the parameterized version of the absolute value operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> |A + a| + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(AbsParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.hpp index 44f8c1fde81d85bd478b0c6a90115da867a7e869..0ab3bd3e984733d20957a935c5d05f5786f1b391 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs/parameterized_absolute_value.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/abs/absolute_value.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_abs_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized absolute value operator * */ class AbsParamNode: public AbsNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/absolute_difference.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/absolute_difference.cpp index ca73bda552b75146955c5587ff4dd55ad1376f59..2e6e80e15527392406838f4d55591210c5437ec9 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/absolute_difference.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/absolute_difference.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/absolute_difference.hpp + * @brief Implements a class for the absolute difference operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the binary operator -> |A - B| + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/absolute_difference.hpp" #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sub/subtract.hpp" diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.cpp index 8db24edb020a2fa530683e70a91cb01de48013d7..c41c661f1c224ca264d79b3b369d036a1fc2946f 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.cpp + * @brief Implements a class for the parameterized version of the absolute difference operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> |A - alpha * B + a| + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(AbsDiffParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.hpp index eedf1ec017885ff84e6ba4e389fa40ee434e6457..cc5327c3a3c08db5e2994c34c916c9794249df24 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/parameterized_absolute_difference.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/abs_diff/absolute_difference.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_abs_diff_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized absolute difference operator * */ class AbsDiffParamNode: public AbsDiffNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/add.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/add.cpp index 48c639337fb35534f8b5ac5cd39a011bc059c601..40095cae9299e1dc586eed07aec77ecbf60bd777 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/add.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/add.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/add.cpp + * @brief Implements a class for the addition operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the binary operator -> A + B + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/add/add.hpp" void generateAddNode(std::vector<node_ptr>& feat_list, const node_ptr feat_1, const node_ptr feat_2, unsigned long int& feat_ind, const double l_bound, const double u_bound) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.cpp index 2e6c7763de2441ffbc5c7d40a92feae51413a6e2..d617522a3ee9a1507ee4ced0039e69eceb6d99b6 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.cpp + * @brief Implements a class for the parameterized version of the addition operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> A + alpha * B + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(AddParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.hpp index 9010d711e58d544c1424988c9dc144c97ae66327..951a408b8f7cdfebb28d7c70e95be47e6a9ffe99 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/add/parameterized_add.hpp @@ -29,7 +29,7 @@ // DocString: cls_param_add_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized addition operator * */ class AddParamNode: public AddNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/cube.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/cube.cpp index bcd1b8299e846391edf12578ae49f8f26987e401..f9e9da5f850ac4faec185fd211bd87705bbc9012 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/cube.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/cube.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/cube.cpp + * @brief Implements a class for the cube operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> (A)^3 + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/cb/cube.hpp" void generateCbNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.cpp index fd465f0a5126293dc91cfdfa19d99e058a244565..66f7785a7107d67016f658e9d4035a040e95a9a4 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.cpp + * @brief Implements a class for the parameterized version of the cube operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> (A + a)^3 + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(CbParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.hpp index 695354b5e985448c64498296e8be688895e2b745..f21824780cc0bb580b576c89481202095ef6c28d 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cb/parameterized_cube.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/cb/cube.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_cb_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized cube operator * */ class CbParamNode: public CbNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/cube_root.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/cube_root.cpp index 7d31aec2339734ebb72fc5919268ecb968323af3..61e2a2e0c42b3593dd3b24e507b09fc9d7a11184 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/cube_root.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/cube_root.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/cube_root.cpp + * @brief Implements a class for the cube root operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> (A)^(1/3) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/cube_root.hpp" void generateCbrtNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.cpp index 2841784d22dee0d6632bb91b25e43d5fb4e1f5d4..d1e85cd92e2235884c984c0371dcf9f2edf7e6c5 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.cpp + * @brief Implements a class for the parameterized version of the cube root operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> cbrt(A + a) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(CbrtParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.hpp index 8eb647abe2a0e803f79f5f779d32879115549f6b..e13a2a18cb4f13d6369c6943017e4f256e6cf080 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/parameterized_cube_root.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/cbrt/cube_root.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_cbrt_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized cube root operator * */ class CbrtParamNode: public CbrtNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/cos.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/cos.cpp index 81d1dff2b5506937312581ce72d4b42b23908e78..54d3c909f83ecc10f002cfab1d76a856fb1e1fcf 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/cos.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/cos.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/cos.cpp + * @brief Implements a class for the cosine operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> cos(A) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/cos/cos.hpp" void generateCosNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.cpp index b7a51e4cc1a27cff1618003685fe0094e1647c28..2cfb64621e91ada64d7b868ef560ef72ff71bd53 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.cpp + * @brief Implements a class for the parameterized version of the cosine operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> cos(alpha * A + a) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(CosParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.hpp index f6a5795a80ec0a480ae60035ccffb41c016a05e6..03ac3049815e7cbd78270c5a9bf24968bf619697 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/cos/parameterized_cos.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/cos/cos.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_cos_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized cosine operator * */ class CosParamNode: public CosNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.cpp index 013d9eadb3bf7389ce4610abc43c4b9818fe3c57..9b3dbac3b8d9ab3168fac7aa57267e2d81ebe091 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/divide.cpp + * @brief Implements a class for the division operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the binary operator -> A / B + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.hpp" void generateDivNode(std::vector<node_ptr>& feat_list, const node_ptr feat_1, const node_ptr feat_2, unsigned long int& feat_ind, const double l_bound, const double u_bound) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.hpp index cd41e0d6164aa83be686bc3c508745d7561f3617..31edcc6c027238e66a5bde523f889b5a607a83b1 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.hpp @@ -29,7 +29,7 @@ // DocString: cls_div_node /** - * @brief Node for the divide operator + * @brief Node for the division operator * */ class DivNode: public OperatorNode<2> diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.cpp index 67911e01ac03170762a18e6c7ccc70653902ca33..6b091811956a772e4122607805445ed81cf4d610 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.cpp + * @brief Implements a class for the parameterized version of the division operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> A / (B + a) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(DivParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.hpp index 728b31f6f8d4b16ad2823cd4bf9ffde096d73594..6610ac04b9d7d13045807f53445f8f65b3ec0a98 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_divide.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/div/divide.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_param_add_node +// DocString: cls_div_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized division operator * */ class DivParamNode: public DivNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/exponential.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/exponential.cpp index 8d39be61664d688d0567eb6562599a4e9fbaca39..fd9985013c2378f5b83b630ccf8139985084bc3d 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/exponential.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/exponential.cpp @@ -11,6 +11,15 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/exponential.cpp + * @brief Implements a class for the exponential operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> exp(A) + */ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/exp/exponential.hpp" void generateExpNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponential.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponential.cpp index a0a0e3a26990f355ef702ccaf27648da7e2ecf5e..2bef0070aae9c2310b3c1496a41fb11adeabd99f 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponential.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponential.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponetial.cpp + * @brief Implements a class for the parameterized version of the exponential operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> exp(alpha * A) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponential.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(ExpParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponential.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponential.hpp index f1afbb19e2d94234c90d4050688570220df85cc5..325a144e4dbbe8dafc11d0916f31a8c7d63d9fbd 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponential.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/exp/parameterized_exponential.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/exp/exponential.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_exp_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized exponential operator * */ class ExpParamNode: public ExpNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/inverse.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/inverse.cpp index dd759485618d99425acfe0e8485bc68604490755..35d233dcdad3a04bedc5484967105f67c7dfb774 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/inverse.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/inverse.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/inverse.cpp + * @brief Implements a class for the logarithm operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> 1 / A + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/inv/inverse.hpp" void generateInvNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.cpp index 8356c716262e52784a4c08492e4324974a15de9f..64bd9f56ddce0f6eaae28d7969653a45a0229481 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.cpp + * @brief Implements a class for the parameterized version of the inverse operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> 1.0 / (A + a) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(InvParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.hpp index 4b74a939b71420e18cc7fdca94637ee6875c4b9e..b24be9b47b57f7d0fac3c8d3389671c2473ac53e 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/inv/parameterized_inverse.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/inv/inverse.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_inv_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized inverse operator * */ class InvParamNode: public InvNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.cpp index 39b031f33eed54c5ac7dcc6bca594785e1a8da9b..a98705a44173a3ae12e458753c097aae0e4792c0 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/log.cpp + * @brief Implements a class for the logarithm operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> log(A) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.hpp" void generateLogNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.hpp index fe13c6de63fb927ca51056562ae692a7ac7b8fdd..7419571fe59d1c76c213411c9f6808c94410c7d0 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.hpp @@ -29,7 +29,7 @@ // DocString: cls_log_node /** - * @brief Node for the log operator + * @brief Node for the logarithm operator * */ class LogNode: public OperatorNode<1> diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.cpp index 7d3ad1eabf02cb53440ae57d430d69298217c2e2..10d80053d257060768c8efe64a9133f73350eebd 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.cpp + * @brief Implements a class for the parameterized version of the logarithm operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> log(A + a) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(LogParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.hpp index 45cc0444568a4b54bbc4e4dedd27f0213fbd94f1..a3f6aa932cca8e99c33e1cc1facb469de98a8d45 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/log/parameterized_log.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/log/log.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_log_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized logarithm operator * */ class LogParamNode: public LogNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.cpp index fac10bb3607a843562b5645fd16b5d2212b8e9ef..e284d89aaae2b15ee985c37d5f9c862177d13174 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/multiply.cpp + * @brief Implements a class for the multiplication operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the binary operator -> A * B + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.hpp" void generateMultNode(std::vector<node_ptr>& feat_list, const node_ptr feat_1, const node_ptr feat_2, unsigned long int& feat_ind, const double l_bound, const double u_bound) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.hpp index 07db01bc5a110d3c33b55a8b4aad3df6e17c487e..a09cf41172d1911475bd84c7eadf603b277c8fad 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/OperatorNode.hpp" #include <fmt/core.h> -// DocString: cls_multiplication_node +// DocString: cls_mult_node /** - * @brief Node for the multiply operator + * @brief Node for the multiplication operator * */ class MultNode: public OperatorNode<2> diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/parameterized_multiply.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/parameterized_multiply.cpp index 2af7d4b81c3b1eea115acc0e37d80c357638eb94..47eedc6e306794b68a88459dbc380c664e966c97 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/parameterized_multiply.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/parameterized_multiply.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/div/parameterized_multiply.cpp + * @brief Implements a class for the parameterized version of the multiplication operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> A * (B + a) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/mult/parameterized_multiply.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(MultParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/parameterized_multiply.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/parameterized_multiply.hpp index 87ed744efbad965b4330fc9a6d4523c51112cc89..177997526c474dfc10232dee4940cb709c66aece 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/parameterized_multiply.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/mult/parameterized_multiply.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/mult/multiply.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_param_add_node +// DocString: cls_mult_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized multiplication operator * */ class MultParamNode: public MultNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/negative_exponential.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/negative_exponential.cpp index 98573a7254606232d405c81987021cf132c792e3..152707e78d15847e1cf222f9e57f5349b6a9fa9d 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/negative_exponential.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/negative_exponential.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/negative_exponential.cpp + * @brief Implements a class for the negative exponential operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> exp(-1 * A) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/negative_exponential.hpp" void generateNegExpNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponential.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponential.cpp index 678307c5abc09ba2bc5c2ea816d3eb9e9004f421..b69136851d14b0b37f025373fc38c890e4b0d867 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponential.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponential.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponetial.cpp + * @brief Implements a class for the parameterized version of the negative exponential operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> exp(-alpha * A) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponential.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(NegExpParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponential.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponential.hpp index 3c03a89f6f83204ad4d7b5e8ee30116abc3de9a2..fdef389c7801548ac8d75a320967bef5c1a12aaf 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponential.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/parameterized_negative_exponential.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/neg_exp/negative_exponential.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_neg_exp_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized negative exponential operator * */ class NegExpParamNode: public NegExpNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.cpp index b782a9c6796652787fecaca807d894e147037bae..e48cfd7735789da4679c651b61fb5764affec4df 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.cpp + * @brief Implements a class for the parameterized version of the sine operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> sin(alpha * A + a) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(SinParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.hpp index 5d57c2d336a24ba71efe5f0663169f0130aba59d..d3f06a32a1091360bb5fca33cda98ef6cb9d23b1 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/parameterized_sin.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_sin_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized sine operator * */ class SinParamNode: public SinNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.cpp index 67749f03d912dadf0c1e03932a3dc9f543f25a2c..213c0ee39c47d996e38c1c27ff8d23888afd2e5b 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/sin.cpp + * @brief Implements a class for the sine operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> sin(A) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.hpp" void generateSinNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.hpp index bad70a78c2d218b2655a9c20937124981a81d1d0..bfa5b82316c670b49ba43387b1f619e23a2dbfef 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sin/sin.hpp @@ -15,10 +15,10 @@ /** @file feature_creation/node/operator_nodes/allowed_operator_nodes/sin.hpp * @brief Defines a class for the sine operator * - * This class represents the unary operator -> sin(A) - * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. + * + * This class represents the unary operator -> sin(A) */ #ifndef SIN_NODE diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_power.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_power.cpp index 164c84cbfc57f77c52ecda36153dfe89c6caa773..e2e577f8550c285907722991aff3cde1de6736ca 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_power.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_power.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_pow.cpp + * @brief Implement a class for the parameterized version of the sixth power operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> (A + a)^6 + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_power.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(SixPowParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_power.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_power.hpp index 1e65bf590247f30f7bdaa44c5c972813220f0aea..8b5771b434d37a36b49b13e377ae306ef3d11568 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_power.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/parameterized_sixth_power.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/sixth_power.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_six_pow_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized sixth power operator * */ class SixPowParamNode: public SixPowNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/sixth_power.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/sixth_power.cpp index 503ccf65b4cfa9abd52145f83146984e16ffa3cd..fbc40a7fda50abed0ca9223b3473128af5e4065b 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/sixth_power.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/sixth_power.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/sixth_power.cpp + * @brief Implements a class for the sixth power operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> (A)^6 + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/six_pow/sixth_power.hpp" void generateSixPowNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.cpp index 8bfe1d78d0ff58bad413247ce4f5f6ad71c291f0..fabc8ed6f70611a9071424814e9423edb2a29e4d 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.cpp + * @brief Implements a class for the parameterized version of square operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> (A + a)^2 + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(SqParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.hpp index cd0bd01b987d15b61b95b5d45c10f59db6b1af2a..fe1ce43673c45f2cc5baed7b1042ef8076311acd 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/parameterized_square.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sq/square.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_sq_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized square operator * */ class SqParamNode: public SqNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/square.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/square.cpp index 3ed4aa33bcc582397788bdb96d5169d7d13989e6..75d89ae6e38ed022a7229e15a3719132630888f0 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/square.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sq/square.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/square.cpp + * @brief Implements a class for the square operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> (A)^2 + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sq/square.hpp" void generateSqNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.cpp index 8f7f1fca02be820f23f2e531599a304d8a201a60..d2ba2b0b4f917330d6df1ab8e688e4809f3a3c54 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.cpp + * @brief Implements a class for the parameterized version of square root operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> sqrt(alpha * A + a) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(SqrtParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.hpp index e5563c3a5f79091db4d05479573d6bd369969049..93669a4be356a60c32594c14e6cc302c3e2663a5 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/parameterized_square_root.hpp @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/square_root.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_abs_node +// DocString: cls_sqrt_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized square root operator * */ class SqrtParamNode: public SqrtNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/square_root.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/square_root.cpp index 03da01cd0d81bb27e23778a532be59af3a0cbf3c..93f576bc26f852796b08efcd1254d3e86741ada5 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/square_root.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/square_root.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/square_root.cpp + * @brief Implements a class for the square root operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the unary operator -> (A)^(1/2) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sqrt/square_root.hpp" void generateSqrtNode( diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.cpp index c94afde4bd897bab835cdf91a3c7190ae01645e1..f657102ec901bad52cec5e52f0514f6837c2652e 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.cpp + * @brief Implements a class for the parameterized version of subtraction operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the parameterized unary operator -> A - (alpha * B) + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.hpp" BOOST_SERIALIZATION_ASSUME_ABSTRACT(SubParamNode) diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.hpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.hpp index 778bdbbeb0d4a5413536dd9301c4d10a087312e6..0539e200a26a832fe5494b9878cfcf78df1793fa 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.hpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file feature_creation/node/operator_nodes/allowed_operator_nodes/sub/parameterized_subtract.hpp - * @briefDefines a class for the parameterized version of subtraction operator + * @brief Defines a class for the parameterized version of subtraction operator * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. @@ -27,9 +27,9 @@ #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sub/subtract.hpp" #include "nl_opt/NLOptWrapper.hpp" -// DocString: cls_param_add_node +// DocString: cls_sub_param_node /** - * @brief Node for the absolute value operator + * @brief Node for the parameterized subtraction operator * */ class SubParamNode: public SubNode diff --git a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/subtract.cpp b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/subtract.cpp index e9a97a34dfda440e90057cfbb717ca7edf4ffbce..2c0de8208841308b8611a1a454855a7d7d8218f1 100644 --- a/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/subtract.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_operator_nodes/sub/subtract.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_operator_nodes/subtract.cpp + * @brief Implements a class for the subtraction operator + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class represents the binary operator -> A - B + */ + #include "feature_creation/node/operator_nodes/allowed_operator_nodes/sub/subtract.hpp" void generateSubNode(std::vector<node_ptr>& feat_list, const node_ptr feat_1, const node_ptr feat_2, unsigned long int& feat_ind, const double l_bound, const double u_bound) diff --git a/src/feature_creation/node/operator_nodes/allowed_ops.cpp b/src/feature_creation/node/operator_nodes/allowed_ops.cpp index 2d2b2cc5369f616e26bb8f96090149c5ac196ee1..f54fa8d6f7a1a3740d70c7fecd4cd41890ee668b 100644 --- a/src/feature_creation/node/operator_nodes/allowed_ops.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_ops.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_ops.cpp + * @brief Implements the map that converts std::string descriptions of the operators into their generator functions for non-parameterized operations + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/node/operator_nodes/allowed_ops.hpp" std::map<std::string, un_op_node_gen> allowed_op_maps::unary_operator_map; diff --git a/src/feature_creation/node/operator_nodes/allowed_parameter_ops.cpp b/src/feature_creation/node/operator_nodes/allowed_parameter_ops.cpp index eecfe3c98599005c9dc592c11ced46d4df75b9c4..03b3c2f7101dfc052227e55fe38284c8eb465ffa 100644 --- a/src/feature_creation/node/operator_nodes/allowed_parameter_ops.cpp +++ b/src/feature_creation/node/operator_nodes/allowed_parameter_ops.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/operator_nodes/allowed_parameter_ops.cpp + * @brief Implements the map that converts std::string descriptions of the operators into their generator functions for parameterized operations + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/node/operator_nodes/allowed_ops.hpp" std::map<std::string, un_param_op_node_gen> allowed_op_maps::unary_param_operator_map; diff --git a/src/feature_creation/node/utils.cpp b/src/feature_creation/node/utils.cpp index e64ab8c2b456e4ea0453d021284a6fccf48a5a6a..5d744c6cfd97ebe1e85bea647ce8b66b65576e60 100644 --- a/src/feature_creation/node/utils.cpp +++ b/src/feature_creation/node/utils.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/utils.cpp + * @brief Implements utility functions for handling Features (Nodes) + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/node/utils.hpp" #ifdef PARAMETERIZE diff --git a/src/feature_creation/node/value_storage/nodes_value_containers.cpp b/src/feature_creation/node/value_storage/nodes_value_containers.cpp index 6420763462c32611278aeef03644ce213e2d590f..9a66d2e2cd6964a0ccff34bd66a0fca14dc0f24c 100644 --- a/src/feature_creation/node/value_storage/nodes_value_containers.cpp +++ b/src/feature_creation/node/value_storage/nodes_value_containers.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/node/value_storage/node_value_containers.cpp + * @brief Implements the functions for the central storage area for the feature's input data and the descriptor matrix + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/node/value_storage/nodes_value_containers.hpp" int node_value_arrs::N_SELECTED = 0; diff --git a/src/feature_creation/units/Unit.cpp b/src/feature_creation/units/Unit.cpp index 44c6056aa6408c6baf8ac8d02b3a147278f6e3c6..91d8fd207ed4e65b9a562702bf52b284fa886c6d 100644 --- a/src/feature_creation/units/Unit.cpp +++ b/src/feature_creation/units/Unit.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/unit/Unit.cpp + * @brief Implements a class that represents Units of of the features + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/units/Unit.hpp" Unit::Unit() : diff --git a/src/inputs/InputParser.cpp b/src/inputs/InputParser.cpp index de383519223c28c58e9df29f61acd7e72e4018b8..fc558f197048945439c832969b339ab575162693 100644 --- a/src/inputs/InputParser.cpp +++ b/src/inputs/InputParser.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file inputs/InputParser.cpp + * @brief Implements the class that parses the input file + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class parses and stores the parameters in the input file + */ + #include "inputs/InputParser.hpp" InputParser::InputParser(pt::ptree ip, std::string fn, std::shared_ptr<MPI_Interface> comm) : diff --git a/src/inputs/InputParser.hpp b/src/inputs/InputParser.hpp index 5eacc33e74bb1221db6752c347d50d39a0487741..d28ab3b3867c4dbde94281e291cf4c357a4c1b80 100644 --- a/src/inputs/InputParser.hpp +++ b/src/inputs/InputParser.hpp @@ -40,9 +40,10 @@ namespace pt = boost::property_tree; +// DocString: cls_input_parser /** - * @brief input parameters class for the parallel FDTD class - * @details sores all the values necessary to convert the input files into a fdtd grid + * @brief A class that parses the input files and constructs the FeatureSpace + * */ class InputParser { diff --git a/src/loss_function/LossFunction.cpp b/src/loss_function/LossFunction.cpp index dfa5cda1c2952a9595d7b8604e188dd3cc897a3c..8389333ebac0cb3581a62465e5be4a38a3c9a7a5 100644 --- a/src/loss_function/LossFunction.cpp +++ b/src/loss_function/LossFunction.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file loss_function/LossFunction.cpp + * @brief Implements a base class used to calculate the projection score and l0-regularization objective function + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "loss_function/LossFunction.hpp" LossFunction::LossFunction( diff --git a/src/loss_function/LossFunction.hpp b/src/loss_function/LossFunction.hpp index 71c21931057622508f203b738b93a92fedc7ebde..12df655336e6022b37419b4c4b652e146ff93642 100644 --- a/src/loss_function/LossFunction.hpp +++ b/src/loss_function/LossFunction.hpp @@ -24,6 +24,11 @@ #include "feature_creation/node/ModelNode.hpp" +// DocString: cls_loss_function +/** + * @brief The loss function used to project features onto the property and calculate the loss function of the models + * + */ class LossFunction { protected: diff --git a/src/loss_function/LossFunctionConvexHull.cpp b/src/loss_function/LossFunctionConvexHull.cpp index 12a7b743ce5516a01b26336cc95e226ddf2d358a..9ff1416f075dfc22d5751db0343ce440b30e6506 100644 --- a/src/loss_function/LossFunctionConvexHull.cpp +++ b/src/loss_function/LossFunctionConvexHull.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file loss_function/LossFunctionConvexHull.cpp + * @brief Implements the class that uses a convex hull projection operator and a convex hull based objective function + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "loss_function/LossFunctionConvexHull.hpp" LossFunctionConvexHull::LossFunctionConvexHull( diff --git a/src/loss_function/LossFunctionConvexHull.hpp b/src/loss_function/LossFunctionConvexHull.hpp index 88d663e4c58ee096585a71f45a334a8aae9614c1..9a56417c367d4bf7619a09ca7cbe54e76ffae4e5 100644 --- a/src/loss_function/LossFunctionConvexHull.hpp +++ b/src/loss_function/LossFunctionConvexHull.hpp @@ -30,6 +30,11 @@ #include "utils/vector_utils.hpp" +// DocString: cls_loss_function_convex_hull +/** + * @brief The loss function used for classification problems + * + */ class LossFunctionConvexHull: public LossFunction { protected: diff --git a/src/loss_function/LossFunctionLogPearsonRMSE.cpp b/src/loss_function/LossFunctionLogPearsonRMSE.cpp index e8b8c5ec4020bc4328d6b24355fbdf0e5339a989..e2e03cfebe4880e46a1fb6bcdade5681ee9c2b6c 100644 --- a/src/loss_function/LossFunctionLogPearsonRMSE.cpp +++ b/src/loss_function/LossFunctionLogPearsonRMSE.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file loss_function/LossFunctionLogPearsonRMSE.cpp + * @brief Implements the class that uses a logarithmic Pearson correlation projection operator and a logarithmic least-squares regression objective function + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "loss_function/LossFunctionLogPearsonRMSE.hpp" LossFunctionLogPearsonRMSE::LossFunctionLogPearsonRMSE( diff --git a/src/loss_function/LossFunctionLogPearsonRMSE.hpp b/src/loss_function/LossFunctionLogPearsonRMSE.hpp index 9db2a99e4d48f3ac5c2370b36d7f2cb415bfa5f7..58aaecfebb2bdc3b1f73f9e656c30b413c8e9c4c 100644 --- a/src/loss_function/LossFunctionLogPearsonRMSE.hpp +++ b/src/loss_function/LossFunctionLogPearsonRMSE.hpp @@ -24,6 +24,11 @@ #include "loss_function/LossFunctionPearsonRMSE.hpp" +// DocString: cls_loss_function_log_pearson_rmse +/** + * @brief The loss function used for log regression problems + * + */ class LossFunctionLogPearsonRMSE: public LossFunctionPearsonRMSE { protected: diff --git a/src/loss_function/LossFunctionPearsonRMSE.cpp b/src/loss_function/LossFunctionPearsonRMSE.cpp index 34fbd8839adec9386c873e94e2b72b066c2a115f..79d2a00d888d5515fb6b0bfc525bd5aa18d68195 100644 --- a/src/loss_function/LossFunctionPearsonRMSE.cpp +++ b/src/loss_function/LossFunctionPearsonRMSE.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file loss_function/LossFunctionPearsonRMSE.cpp + * @brief Implements the class that uses a Pearson correlation projection operator and a least-squares regression objective function + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "loss_function/LossFunctionPearsonRMSE.hpp" LossFunctionPearsonRMSE::LossFunctionPearsonRMSE( diff --git a/src/loss_function/LossFunctionPearsonRMSE.hpp b/src/loss_function/LossFunctionPearsonRMSE.hpp index 40eb51eac033b49a2b859559b7e0baceafb78e3b..337531f99bb280224a19adf8e46378bb436a1d7b 100644 --- a/src/loss_function/LossFunctionPearsonRMSE.hpp +++ b/src/loss_function/LossFunctionPearsonRMSE.hpp @@ -24,6 +24,11 @@ #include "loss_function/LossFunction.hpp" +// DocString: cls_loss_function_pearson_rmse +/** + * @brief The loss function used for regression problems + * + */ class LossFunctionPearsonRMSE: public LossFunction { protected: diff --git a/src/loss_function/utils.cpp b/src/loss_function/utils.cpp index b86948bd906b8cb2bcc1f8602663317ba1bc4fca..8b70c55ea75b9fdc76ae88273e89cd9e2248873d 100644 --- a/src/loss_function/utils.cpp +++ b/src/loss_function/utils.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file loss_function/utils.cpp + * @brief Implements utilities for generating and copying LossFunctions + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "loss_function/utils.hpp" std::shared_ptr<LossFunction> loss_function_util::get_loss_function( std::string type, diff --git a/src/main.cpp b/src/main.cpp index 2152f897ee40f30d7a840b65789703127133e8da..43de7468ba7dc032e6c9676e7354843b1fbf0556 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file main.cpp + * @brief The main executable used to run SISSO++ + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "inputs/InputParser.hpp" #include "descriptor_identifier/solver/SISSOLogRegressor.hpp" #include "descriptor_identifier/solver/SISSOClassifier.hpp" diff --git a/src/mpi_interface/MPI_Interface.cpp b/src/mpi_interface/MPI_Interface.cpp index efad1414cf7cac7205715425ba9de85399dabdb3..3c7ddae0bd34a4a4a649bee1b72d5de55b37db8f 100644 --- a/src/mpi_interface/MPI_Interface.cpp +++ b/src/mpi_interface/MPI_Interface.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file mpi_interface/MPI_Interface.hpp + * @brief Implements the MPI interface for the calculations + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This class modifies the boost mpi::communicator for easier communication + */ + #include "mpi_interface/MPI_Interface.hpp" MPI_Interface::MPI_Interface() : boost::mpi::communicator() diff --git a/src/mpi_interface/MPI_Interface.hpp b/src/mpi_interface/MPI_Interface.hpp index 00046efdd78bc3a2618c32e74915dbf9c8b52277..c1eb3650eb3cc0e2c2c8f09516bc51cb6b3f6dd3 100644 --- a/src/mpi_interface/MPI_Interface.hpp +++ b/src/mpi_interface/MPI_Interface.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file mpi_interface/MPI_Interface.hpp - * @brief Define MPI interface for the calculations + * @brief Defines the MPI interface for the calculations * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. @@ -29,9 +29,9 @@ namespace mpi = boost::mpi; +// DocString: cls_mpi_interface /** - * @brief Augment the boost MPI communicator class with some other useful data - * @details MPI communicator used to transfer data throughout the cell. + * @brief Augment the boost MPI communicator class with some other useful data and other functions * */ class MPI_Interface : public mpi::communicator diff --git a/src/mpi_interface/MPI_Ops.cpp b/src/mpi_interface/MPI_Ops.cpp index cdb20899d5dcf5b3081895d44bd132bb41c1cf4d..dee6afba9a418c5f472e0eb435e44978ea677183 100644 --- a/src/mpi_interface/MPI_Ops.cpp +++ b/src/mpi_interface/MPI_Ops.cpp @@ -11,6 +11,16 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file mpi_interface/MPI_Ops.cpp + * @brief Implements MPI reduce all operator to facilitate a distributed sorting algorithm + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + * + * This is based off of a project from Meisam Farzalipour Tabriz at the MPCDF (mpi_topk) + */ + #include "mpi_interface/MPI_Ops.hpp" // MPI_Op top_feats; diff --git a/src/mpi_interface/MPI_Ops.hpp b/src/mpi_interface/MPI_Ops.hpp index f0026b946b0fa7c3e4facaca7eae0bbf488dee4f..cfa62b5ba648f3f60a4609dd9069cd5c1d9b93ca 100644 --- a/src/mpi_interface/MPI_Ops.hpp +++ b/src/mpi_interface/MPI_Ops.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file mpi_interface/MPI_Ops.hpp - * @brief Define MPI reduce all operator to facilitate a distributed sorting algorithm + * @brief Defines MPI reduce all operator to facilitate a distributed sorting algorithm * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. diff --git a/src/nl_opt/NLOptWrapper.cpp b/src/nl_opt/NLOptWrapper.cpp index 50719c0a9d1b94cd48c68cfdd2ada998feae8e21..770c7c95e5bb336a2910274c221a865d980bd324 100644 --- a/src/nl_opt/NLOptWrapper.cpp +++ b/src/nl_opt/NLOptWrapper.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file feature_creation/parameterization/NLOptWrapper.cpp + * @brief Implements a wrapper for NLopt library functions and functions for using the library + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "nl_opt/NLOptWrapper.hpp" int nlopt_wrapper::MAX_PARAM_DEPTH = -1; diff --git a/src/nl_opt/NLOptWrapper.hpp b/src/nl_opt/NLOptWrapper.hpp index bf4aceb101f3f4abb3825cfdf51c1e39c9c32667..183c6abed4e8be5183fafd53798a6278c7b917f2 100644 --- a/src/nl_opt/NLOptWrapper.hpp +++ b/src/nl_opt/NLOptWrapper.hpp @@ -26,6 +26,11 @@ #include "feature_creation/node/Node.hpp" #include "classification/ConvexHull1D.hpp" +// DocString: cls_nl_opt +/** + * @brief A wrapper to the NLopt library files + * + */ class NLOptimizer { protected: diff --git a/src/python/py_binding_cpp_def/_sisso.cpp b/src/python/py_binding_cpp_def/_sisso.cpp index fece4ea738504d7f2c681a6ea0ee33a97981bf09..1ed9eb443abc6e324ba50fa39be904a9a240c0e7 100644 --- a/src/python/py_binding_cpp_def/_sisso.cpp +++ b/src/python/py_binding_cpp_def/_sisso.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/_sisso.cpp + * @brief Implements the SISSO Library that binds the C++ structure to python + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include <boost/python/suite/indexing/map_indexing_suite.hpp> #include <boost/python/numpy.hpp> diff --git a/src/python/py_binding_cpp_def/bindings_docstring_keyed.cpp b/src/python/py_binding_cpp_def/bindings_docstring_keyed.cpp index ab9125e9bea0f78fc20677a8aad7868713dd8d42..f1c54257763d0942e1452344110692eb1be6c186 100644 --- a/src/python/py_binding_cpp_def/bindings_docstring_keyed.cpp +++ b/src/python/py_binding_cpp_def/bindings_docstring_keyed.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/bindings.cpp + * @brief Implements the functions used to convert C++ classes into python classes + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "python/py_binding_cpp_def/bindings.hpp" using namespace boost::python; diff --git a/src/python/py_binding_cpp_def/bindings_docstring_keyed.hpp b/src/python/py_binding_cpp_def/bindings_docstring_keyed.hpp index afffbf501a3ae7c9894e761a7a34a92fae571b29..198aa54655f27880144e214a704a126acbe1f718 100644 --- a/src/python/py_binding_cpp_def/bindings_docstring_keyed.hpp +++ b/src/python/py_binding_cpp_def/bindings_docstring_keyed.hpp @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -/** @file python/bindings.hpp +/** @file python/py_bindings_cpp_def/bindings.hpp * @brief Definitions to convert C++ classes into python classes * * @author Thomas A. R. Purcell (tpurcell90) diff --git a/src/python/py_binding_cpp_def/descriptor_identifier/Model.cpp b/src/python/py_binding_cpp_def/descriptor_identifier/Model.cpp index 408d094b562b73649852dea26459948f498d030a..8005d0e3779ce524bc799e4dbfecb282c543e209 100644 --- a/src/python/py_binding_cpp_def/descriptor_identifier/Model.cpp +++ b/src/python/py_binding_cpp_def/descriptor_identifier/Model.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/descriptor_identifier/Model.cpp + * @brief Implements the python based functionality of the base class of the output Models for SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/model/Model.hpp" np::ndarray Model::eval_many_py(np::ndarray x_in) const diff --git a/src/python/py_binding_cpp_def/descriptor_identifier/ModelClassifier.cpp b/src/python/py_binding_cpp_def/descriptor_identifier/ModelClassifier.cpp index 59d876a2cf1d9caf135525a472f2b2ce9d60d82a..787ca61d58de69c77fc377d5ae065bccdb25398f 100644 --- a/src/python/py_binding_cpp_def/descriptor_identifier/ModelClassifier.cpp +++ b/src/python/py_binding_cpp_def/descriptor_identifier/ModelClassifier.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/descriptor_identifier/ModelClassifier.cpp + * @brief Implements the python based functionality of the class for the output models from solving a classification problem + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/model/ModelClassifier.hpp" ModelClassifier::ModelClassifier(const ModelClassifier& o, py::list new_coefs, np::ndarray prop_train_est, np::ndarray prop_test_est) : diff --git a/src/python/py_binding_cpp_def/descriptor_identifier/SISSOClassifier.cpp b/src/python/py_binding_cpp_def/descriptor_identifier/SISSOClassifier.cpp index a96481c2e2ca5a906596ec8fe1f45b72aa59ce45..acec91cc800c845a3d5603c07267dfb4c1e761b3 100644 --- a/src/python/py_binding_cpp_def/descriptor_identifier/SISSOClassifier.cpp +++ b/src/python/py_binding_cpp_def/descriptor_identifier/SISSOClassifier.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/descriptor_identifier/SISSOClassifier.cpp + * @brief Implements the python based functionality of the class for solving classification problems with SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/solver/SISSOClassifier.hpp" SISSOClassifier::SISSOClassifier( diff --git a/src/python/py_binding_cpp_def/descriptor_identifier/SISSOLogRegressor.cpp b/src/python/py_binding_cpp_def/descriptor_identifier/SISSOLogRegressor.cpp index a4d3aea28eea5086dc0a4087d054163335f4f096..20083bdf27700f5579589e9b8b49958e21753dea 100644 --- a/src/python/py_binding_cpp_def/descriptor_identifier/SISSOLogRegressor.cpp +++ b/src/python/py_binding_cpp_def/descriptor_identifier/SISSOLogRegressor.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/descriptor_identifier/SISSOLogRegressor.cpp + * @brief Implements the python based functionality of the class for solving logarithmic regression problems with SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/solver/SISSOLogRegressor.hpp" SISSOLogRegressor::SISSOLogRegressor( diff --git a/src/python/py_binding_cpp_def/descriptor_identifier/SISSORegressor.cpp b/src/python/py_binding_cpp_def/descriptor_identifier/SISSORegressor.cpp index 31afce12163002ad9be20bc81929c083d8d9d327..96eec02c3c4786ce5c2369d86996a7ff186ec8d1 100644 --- a/src/python/py_binding_cpp_def/descriptor_identifier/SISSORegressor.cpp +++ b/src/python/py_binding_cpp_def/descriptor_identifier/SISSORegressor.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/descriptor_identifier/SISSORegressor.cpp + * @brief Implements the python based functionality of the class for solving regression problems with SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/solver/SISSORegressor.hpp" SISSORegressor::SISSORegressor( diff --git a/src/python/py_binding_cpp_def/descriptor_identifier/SISSOSolver.cpp b/src/python/py_binding_cpp_def/descriptor_identifier/SISSOSolver.cpp index 4df1d20f30849432dcc4036822ba2e843c3083f1..4152b2b6b9af7f550f61f3f150f891b1c3eea400 100644 --- a/src/python/py_binding_cpp_def/descriptor_identifier/SISSOSolver.cpp +++ b/src/python/py_binding_cpp_def/descriptor_identifier/SISSOSolver.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/descriptor_identifier/SISSOSolver.cpp + * @brief Implements the python based functionality of the base class for creating solvers using SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "descriptor_identifier/solver/SISSOSolver.hpp" SISSOSolver::SISSOSolver( diff --git a/src/python/py_binding_cpp_def/feature_creation/FeatureNode.cpp b/src/python/py_binding_cpp_def/feature_creation/FeatureNode.cpp index 54950b8f247f5a629975dfb6cb4cd7777994e840..61b100fc2135105f814e2a3c9c06dada05dcd91d 100644 --- a/src/python/py_binding_cpp_def/feature_creation/FeatureNode.cpp +++ b/src/python/py_binding_cpp_def/feature_creation/FeatureNode.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/feature_creation/FeatureNode.cpp + * @brief Implements the python based functionality of the class that represent the primary features in SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/node/FeatureNode.hpp" FeatureNode::FeatureNode(unsigned long int feat_ind, std::string expr, np::ndarray value, np::ndarray test_value, Unit unit) : diff --git a/src/python/py_binding_cpp_def/feature_creation/FeatureSpace.cpp b/src/python/py_binding_cpp_def/feature_creation/FeatureSpace.cpp index 0888272a1f547b32d7645f54d0171ef6899e11ba..54b9ffff698cd965475423394487f9fdd6e9cd0d 100644 --- a/src/python/py_binding_cpp_def/feature_creation/FeatureSpace.cpp +++ b/src/python/py_binding_cpp_def/feature_creation/FeatureSpace.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/feature_creation/FeatureSoace.cpp + * @brief Implements the python based functionality of the class for creating/operating on a feature space in SISSO + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/feature_space/FeatureSpace.hpp" #ifdef PARAMETERIZE diff --git a/src/python/py_binding_cpp_def/feature_creation/ModelNode.cpp b/src/python/py_binding_cpp_def/feature_creation/ModelNode.cpp index 531036d67479546397f36e42b7118ccf209f2521..2524fd4117646c1af0f36355fbefe501201c5b7f 100644 --- a/src/python/py_binding_cpp_def/feature_creation/ModelNode.cpp +++ b/src/python/py_binding_cpp_def/feature_creation/ModelNode.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/py_bindings_cpp_def/feature_creation/FeatureSoace.cpp + * @brief Implements the python based functionality of the class used to transfer features (Nodes) to the Model objects + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "feature_creation/node/ModelNode.hpp" ModelNode::ModelNode( diff --git a/src/python/py_binding_cpp_def/feature_creation/node_utils.cpp b/src/python/py_binding_cpp_def/feature_creation/node_utils.cpp index 5f9bb441169799ee08fd77f2adf7c6c83b7b7049..e0b168661c2ad43fd716e7f293fb00367187f87c 100644 --- a/src/python/py_binding_cpp_def/feature_creation/node_utils.cpp +++ b/src/python/py_binding_cpp_def/feature_creation/node_utils.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file python/feature_creation/node_utils.cpp + * @brief Implements a function to convert a file containing a list of postfix expressions of features into a list of Nodes + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "python/py_binding_cpp_def/feature_creation/node_utils.hpp" py::list str2node::phi_selected_from_file_py(std::string filename, py::list phi_0) diff --git a/src/utils/compare_features.cpp b/src/utils/compare_features.cpp index 64c49791d9f250156eed2f34ca9bbbc761d27607..1313376b2db630b1d1dfe75f9c1b1378491365a0 100644 --- a/src/utils/compare_features.cpp +++ b/src/utils/compare_features.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file utils/compare_features.hpp + * @brief Implements a set of functions to compare features to see if they are too correlated to other selected features to be selected here + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "utils/compare_features.hpp" #include <iomanip> std::vector<double> comp_feats::CORR_CHECK; diff --git a/src/utils/compare_features.hpp b/src/utils/compare_features.hpp index 9e5a459a2b58731e4432b8939e05241425ded311..9573ae785efc9e0c4ba068bf89ffdff274856798 100644 --- a/src/utils/compare_features.hpp +++ b/src/utils/compare_features.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file utils/compare_features.hpp - * @brief A set of functions to project features onto a second vector + * @brief Defines a set of functions to compare features to see if they are too correlated to other selected features to be selected here * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. diff --git a/src/utils/enum.hpp b/src/utils/enum.hpp index f3f793d8e48b683b5cda7e07970b9570259a0197..87060ea1d6e19600ff67ab6752e290312021b55c 100644 --- a/src/utils/enum.hpp +++ b/src/utils/enum.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file utils/enum.hpp - * @brief Define node type enum + * @brief Define enum classes for the library * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. diff --git a/src/utils/math_funcs.cpp b/src/utils/math_funcs.cpp index 7a5226019029e07096a356bcef9b90e56e8e1a7d..247a90ed2733ab611fde97a1ad8daa9212b0b2f4 100644 --- a/src/utils/math_funcs.cpp +++ b/src/utils/math_funcs.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file utils/math_funcs.cpp + * @brief Implements a set of functions to get standardized mathematical operations on + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "utils/math_funcs.hpp" bool util_funcs::iterate(std::vector<int>& inds, int size, int incriment) diff --git a/src/utils/math_funcs.hpp b/src/utils/math_funcs.hpp index 8a0346fff9d8b9699155891fea2242bd8da9f122..6bcdd5490b1de82e71445399a01c8b7df61df8d7 100644 --- a/src/utils/math_funcs.hpp +++ b/src/utils/math_funcs.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file utils/math_funcs.hpp - * @brief A set of functions to get standardized mathematical operations on + * @brief Defines a set of functions to get standardized mathematical operations on * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. diff --git a/src/utils/mkl_interface.hpp b/src/utils/mkl_interface.hpp index d7de6e53f5985d08fe8bd877fc70b46de733541e..b5935f2e68144b78a55a358537e7efb4b31dbaec 100644 --- a/src/utils/mkl_interface.hpp +++ b/src/utils/mkl_interface.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file utils/mkl_interface.hpp - * @brief wrapper functions to a mkl blas functionality + * @brief Defines and implements wrapper functions to a mkl blas functionality * * @author Thomas A. Purcell (tpurcell90) * @bug No known bugs diff --git a/src/utils/project.cpp b/src/utils/project.cpp index 2657828cd60ab91208450ccf63053c43c15b24b1..12d5e0f4bad48f4815e85b4e7fa04a6a6c951f4c 100644 --- a/src/utils/project.cpp +++ b/src/utils/project.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file utils/project.cpp + * @brief Implements a set of functions to project features onto a second vector + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "utils/project.hpp" void project_funcs::project_r( diff --git a/src/utils/project.hpp b/src/utils/project.hpp index 27d569007877dfbbbe6b86a60f45e07d8ffd426f..c372102d9f9ea0fa54c849889b1f787b63deec52 100644 --- a/src/utils/project.hpp +++ b/src/utils/project.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file utils/project.hpp - * @brief A set of functions to project features onto a second vector + * @brief Defines a set of functions to project features onto a second vector * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. diff --git a/src/utils/string_utils.cpp b/src/utils/string_utils.cpp index d9f9ae8d0c527179e656ff695e169a4e2db59f64..dbc7e42d53cf950f27a168a03d40b9916bd9fbb1 100644 --- a/src/utils/string_utils.cpp +++ b/src/utils/string_utils.cpp @@ -11,6 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. + +/** @file utils/string_utils.cpp + * @brief Implements a set of functions to manipulate strings + * + * @author Thomas A. R. Purcell (tpurcell90) + * @bug No known bugs. + */ + #include "utils/string_utils.hpp" std::vector<std::string> str_utils::split_string_trim(const std::string str, const std::string split_tokens) diff --git a/src/utils/string_utils.hpp b/src/utils/string_utils.hpp index ea1dca4c6d56b76724b89699ba8fbdeef76d0fa3..3e0d51a56ccf0cbf4aa9dcdc46b79eb52ae861c3 100644 --- a/src/utils/string_utils.hpp +++ b/src/utils/string_utils.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file utils/string_utils.hpp - * @brief A set of functions to manipulate strings + * @brief Defines a set of functions to manipulate strings * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs. diff --git a/src/utils/vector_utils.hpp b/src/utils/vector_utils.hpp index 87b9345f84cfd351065fc50fc317c7852edd7eb7..4bb66ca2805afcf362dcc74fb846b55ee75e9e0b 100644 --- a/src/utils/vector_utils.hpp +++ b/src/utils/vector_utils.hpp @@ -13,7 +13,7 @@ // limitations under the License. /** @file utils/vector_utils.hpp - * @brief A set of functions to manipulate vectors + * @brief Defines and implements set of functions to manipulate vectors * * @author Thomas A. R. Purcell (tpurcell90) * @bug No known bugs.