Commit 7d215bee authored by Thomas Purcell's avatar Thomas Purcell
Browse files

Update file docstrings for C++ header files and standardize path names

parent 63884b07
......@@ -11,14 +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.hpp
* @brief Class describing the cube root operator
*
* This class represents the unary operator -> (A)^(1/3)
* @brief Defines a class for the cube root operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the unary operator -> (A)^(1/3)
*/
#ifndef CBRT_NODE
#define CBRT_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized cube root operator
*
* This class represents the parameterized unary operator -> cbrt(alpha * A + a)
* @brief Defines a class for the parameterized version of the cube root operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> cbrt(A + a)
*/
#ifndef PARAM_CBRT_NODE
#define PARAM_CBRT_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the cosine operator
*
* This class represents the unary operator -> cos(A)
* @brief Defines a class for the cosine operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the unary operator -> cos(A)
*/
#ifndef COS_NODE
#define COS_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized cos operator
*
* This class represents the parameterized unary operator -> cos(alpha * A + a)
* @brief Defines a class for the parameterized version of the cosine operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> cos(alpha * A + a)
*/
#ifndef PARAM_COS_NODE
#define PARAM_COS_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the division operator
*
* This class represents the binary operator -> A / B
* @brief Defines a class for the division operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the binary operator -> A / B
*/
#ifndef DIV_NODE
#define DIV_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized addition operator
*
* This class represents the parameterized unary operator -> A / (alpha * B + a)
* @brief Defines a class for the parameterized version of the division operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> A / (B + a)
*/
#ifndef PARAM_DIV_NODE
#define PARAM_DIV_NODE
......
......@@ -11,14 +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/exponential.hpp
* @brief Class describing the exponential operator
*
* This class represents the unary operator -> exp(A)
* @brief Defines a class for the exponential operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the unary operator -> exp(A)
*/
#ifndef EXP_NODE
#define EXP_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized exp operator
*
* This class represents the parameterized unary operator -> exp(alpha * A + a)
* @brief Defines a class for the parameterized version of the exponential operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> exp(alpha * A)
*/
#ifndef PARAM_EXP_NODE
#define PARAM_EXP_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the logarithm operator
*
* This class represents the unary operator -> 1 / A
* @brief Defines a class for the logarithm operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the unary operator -> 1 / A
*/
#ifndef INV_NODE
#define INV_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized inverse operator
*
* This class represents the parameterized unary operator -> 1.0 / (alpha * A + a)
* @brief Defines a class for the parameterized version of the inverse operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> 1.0 / (A + a)
*/
#ifndef PARAM_INV_NODE
#define PARAM_INV_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the logarithm operator
*
* This class represents the unary operator -> log(A)
* @brief Defines a class for the logarithm operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the unary operator -> log(A)
*/
#ifndef LOG_NODE
#define LOG_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized log operator
*
* This class represents the parameterized unary operator -> log(alpha * A + a)
* @brief Defines a class for the parameterized version of the logarithm operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> log(A + a)
*/
#ifndef PARAM_LOG_NODE
#define PARAM_LOG_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the multiplication operator
*
* This class represents the binary operator -> A * B
* @brief Defines a class for the multiplication operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the binary operator -> A * B
*/
#ifndef MULT_NODE
#define MULT_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized addition operator
*
* This class represents the parameterized unary operator -> A * (alpha * B + a)
* @brief Defines a class for the parameterized version of the multiplication operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> A * (B + a)
*/
#ifndef PARAM_MULT_NODE
#define PARAM_MULT_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the negative exponential operator
*
* This class represents the unary operator -> exp(-1 * A)
* @brief Defines a class for the negative exponential operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the unary operator -> exp(-1 * A)
*/
#ifndef NEG_EXP_NODE
#define NEG_EXP_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized neg_exp operator
*
* This class represents the parameterized unary operator -> exp(-alpha * A + a)
* @brief Defines a class for the parameterized version of the negative exponential operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> exp(-alpha * A)
*/
#ifndef PARAM_NEG_EXP_NODE
#define PARAM_NEG_EXP_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized sin operator
*
* This class represents the parameterized unary operator -> sin(alpha * A + a)
* @brief Defines a class for the parameterized version of the sine operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> sin(alpha * A + a)
*/
#ifndef PARAM_SIN_NODE
#define PARAM_SIN_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the sine operator
* @brief Defines a class for the sine operator
*
* This class represents the unary operator -> sin(A)
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*/
#ifndef SIN_NODE
#define SIN_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the parameterized sixth power operator
*
* This class represents the parameterized unary operator -> (alpha * A + a)^6
* @brief Defines a class for the parameterized version of the sixth power operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the parameterized unary operator -> (A + a)^6
*/
#ifndef PARAM_SIX_POW_NODE
#define PARAM_SIX_POW_NODE
......
......@@ -11,14 +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.hpp
* @brief Class describing the sixth power operator
*
* This class represents the unary operator -> (A)^6
* @brief Defines a class for the sixth power operator
*
* @author Thomas A. R. Purcell (tpurcell)
* @author Thomas A. R. Purcell (tpurcell90)
* @bug No known bugs.
*
* This class represents the unary operator -> (A)^6
*/
#ifndef SIXTH_POW_NODE
#define SIXTH_POW_NODE
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment