Merge pull request #41 from uonrobotics/refactor-naming-void-function

Refactor naming void function

Author: chansoonlim

README.md

@@ -25,12 +25,12 @@
   - Using **OpenMP**: Add the -fopenmp flag during compilation and link with the OpenMP library (-lgomp).
 
 ### Available Functions
-- **Array creation routines**: [empty](ctmd/empty.hpp), [empty_like](ctmd/empty_like.hpp), [eye](ctmd/eye.hpp), [ones](ctmd/ones.hpp), [ones_like](ctmd/ones_like.hpp), [zeros](ctmd/zeros.hpp), [zeros_like](ctmd/zeros_like.hpp), [full](ctmd/full.hpp), [full_like](ctmd/full_like.hpp), [copy](ctmd/copy.hpp), [arange](ctmd/arange.hpp), [linspace](ctmd/linspace.hpp).
-- **Array manipulation routines**: [reshape](ctmd/reshape.hpp), [expand_dims](ctmd/expand_dims.hpp), [concatenate](ctmd/concatenate.hpp).
-- **Linear algebra**: [matmul](ctmd/linalg/matmul.hpp), [matvec](ctmd/linalg/matvec.hpp), [vecmat](ctmd/linalg/vecmat.hpp), [norm](ctmd/linalg/norm.hpp), [inv](ctmd/linalg/inv.hpp).
-- **Logic functions**: [all](ctmd/all.hpp), [any](ctmd/any.hpp), [allclose](ctmd/allclose.hpp), [isclose](ctmd/isclose.hpp), [array_equal](ctmd/array_equal.hpp), [array_equiv](ctmd/array_equiv.hpp), [greater](ctmd/greater.hpp), [greater_equal](ctmd/greater_equal.hpp), [less](ctmd/less.hpp), [less_equal](ctmd/less_equal.hpp), [equal](ctmd/equal.hpp), [not_equal](ctmd/not_equal.hpp).
-- **Mathematical functions**: [sin](ctmd/sin.hpp), [cos](ctmd/cos.hpp), [tan](ctmd/tan.hpp), [atan2](ctmd/atan2.hpp), [deg2rad](ctmd/deg2rad.hpp), [rad2deg](ctmd/rad2deg.hpp), [sum](ctmd/sum.hpp), [add](ctmd/add.hpp), [negative](ctmd/negative.hpp), [multiply](ctmd/multiply.hpp), [divide](ctmd/divide.hpp), [subtract](ctmd/subtract.hpp), [maximum](ctmd/maximum.hpp), [minimum](ctmd/minimum.hpp), [clip](ctmd/clip.hpp), [sqrt](ctmd/sqrt.hpp), [absolute](ctmd/absolute.hpp).
-- **Random sampling**: [rand](ctmd/random/rand.hpp), [uniform](ctmd/random/uniform.hpp).
+- **Array creation routines**: [empty](ctmd/ctmd_empty.hpp), [empty_like](ctmd/ctmd_empty_like.hpp), [eye](ctmd/ctmd_eye.hpp), [ones](ctmd/ctmd_ones.hpp), [ones_like](ctmd/ctmd_ones_like.hpp), [zeros](ctmd/ctmd_zeros.hpp), [zeros_like](ctmd/ctmd_zeros_like.hpp), [full](ctmd/ctmd_full.hpp), [full_like](ctmd/ctmd_full_like.hpp), [copy](ctmd/ctmd_copy.hpp), [arange](ctmd/ctmd_arange.hpp), [linspace](ctmd/ctmd_linspace.hpp).
+- **Array manipulation routines**: [reshape](ctmd/ctmd_reshape.hpp), [expand_dims](ctmd/ctmd_expand_dims.hpp), [concatenate](ctmd/ctmd_concatenate.hpp).
+- **Linear algebra**: [matmul](ctmd/linalg/ctmd_linalg_matmul.hpp), [matvec](ctmd/linalg/ctmd_linalg_matvec.hpp), [vecmat](ctmd/linalg/ctmd_linalg_vecmat.hpp), [norm](ctmd/linalg/ctmd_linalg_norm.hpp), [inv](ctmd/linalg/ctmd_linalg_inv.hpp).
+- **Logic functions**: [all](ctmd/ctmd_all.hpp), [any](ctmd/ctmd_any.hpp), [allclose](ctmd/ctmd_allclose.hpp), [isclose](ctmd/ctmd_isclose.hpp), [array_equal](ctmd/ctmd_array_equal.hpp), [array_equiv](ctmd/ctmd_array_equiv.hpp), [greater](ctmd/ctmd_greater.hpp), [greater_equal](ctmd/ctmd_greater_equal.hpp), [less](ctmd/ctmd_less.hpp), [less_equal](ctmd/ctmd_less_equal.hpp), [equal](ctmd/ctmd_equal.hpp), [not_equal](ctmd/ctmd_not_equal.hpp).
+- **Mathematical functions**: [sin](ctmd/ctmd_sin.hpp), [cos](ctmd/ctmd_cos.hpp), [tan](ctmd/ctmd_tan.hpp), [atan2](ctmd/ctmd_atan2.hpp), [deg2rad](ctmd/ctmd_deg2rad.hpp), [rad2deg](ctmd/ctmd_rad2deg.hpp), [sum](ctmd/ctmd_sum.hpp), [add](ctmd/ctmd_add.hpp), [negative](ctmd/ctmd_negative.hpp), [multiply](ctmd/ctmd_multiply.hpp), [divide](ctmd/ctmd_divide.hpp), [subtract](ctmd/ctmd_subtract.hpp), [maximum](ctmd/ctmd_maximum.hpp), [minimum](ctmd/ctmd_minimum.hpp), [clip](ctmd/ctmd_clip.hpp), [sqrt](ctmd/ctmd_sqrt.hpp), [absolute](ctmd/ctmd_absolute.hpp).
+- **Random sampling**: [rand](ctmd/random/ctmd_random_rand.hpp), [uniform](ctmd/random/ctmd_random_uniform.hpp).
 
 ## Installation
 CTMD is a header-only library, so you can start using it by simply including [ctmd/ctmd.hpp](ctmd/ctmd.hpp) in your project.
@@ -88,7 +88,7 @@ bazel test tests/...
 
 Benchmarks (in benchmarks/) are written using [GoogleBenchmark](https://github.com/google/benchmark). To run a benchmark (e.g., matrix addition in double precision):
 ```bash
-bazel run benchmarks/add:pd
+bazel run benchmarks/add/none:ps
 ```
 
 ## About

benchmarks/add/cpump/source.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "benchmark/benchmark.h"
-#include "ctmd/add.hpp"
-#include "ctmd/full.hpp"
+#include "ctmd/ctmd_add.hpp"
+#include "ctmd/ctmd_full.hpp"
 
 namespace md = ctmd;
 
@@ -18,7 +18,7 @@ template <typename T> inline void test(benchmark::State &state) noexcept {
     auto out = md::mdarray<T, md::dims<1>>{md::dims<1>{set_num}};
 
     for (auto _ : state) {
-        md::add(in1, in2, out, md::MPMode::CPUMP);
+        md::add_to(in1, in2, out, md::MPMode::CPUMP);
     }
 
     state.SetComplexityN(state.range(0));

benchmarks/add/gpump/source.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "benchmark/benchmark.h"
-#include "ctmd/add.hpp"
-#include "ctmd/full.hpp"
+#include "ctmd/ctmd_add.hpp"
+#include "ctmd/ctmd_full.hpp"
 
 namespace md = ctmd;
 
@@ -18,7 +18,7 @@ template <typename T> inline void test(benchmark::State &state) noexcept {
     auto out = md::mdarray<T, md::dims<1>>{md::dims<1>{set_num}};
 
     for (auto _ : state) {
-        md::add(in1, in2, out, md::MPMode::GPUMP);
+        md::add_to(in1, in2, out, md::MPMode::GPUMP);
     }
 
     state.SetComplexityN(state.range(0));

benchmarks/add/none/source.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "benchmark/benchmark.h"
-#include "ctmd/add.hpp"
-#include "ctmd/full.hpp"
+#include "ctmd/ctmd_add.hpp"
+#include "ctmd/ctmd_full.hpp"
 
 namespace md = ctmd;
 
@@ -18,7 +18,7 @@ template <typename T> inline void test(benchmark::State &state) noexcept {
     auto out = md::mdarray<T, md::dims<1>>{md::dims<1>{set_num}};
 
     for (auto _ : state) {
-        md::add(in1, in2, out);
+        md::add_to(in1, in2, out);
     }
 
     state.SetComplexityN(state.range(0));

benchmarks/all/none/source.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "benchmark/benchmark.h"
-#include "ctmd/all.hpp"
-#include "ctmd/full.hpp"
+#include "ctmd/ctmd_all.hpp"
+#include "ctmd/ctmd_full.hpp"
 
 namespace md = ctmd;
 

benchmarks/allclose/none/source.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "benchmark/benchmark.h"
-#include "ctmd/allclose.hpp"
-#include "ctmd/full.hpp"
+#include "ctmd/ctmd_allclose.hpp"
+#include "ctmd/ctmd_full.hpp"
 
 namespace md = ctmd;
 

benchmarks/array_equal/none/source.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "benchmark/benchmark.h"
-#include "ctmd/array_equal.hpp"
-#include "ctmd/full.hpp"
+#include "ctmd/ctmd_array_equal.hpp"
+#include "ctmd/ctmd_full.hpp"
 
 namespace md = ctmd;
 

benchmarks/atan2/none/source.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "benchmark/benchmark.h"
-#include "ctmd/atan2.hpp"
-#include "ctmd/random/rand.hpp"
+#include "ctmd/ctmd_atan2.hpp"
+#include "ctmd/random/ctmd_random_rand.hpp"
 
 namespace md = ctmd;
 
@@ -18,7 +18,7 @@ template <typename T> inline void test(benchmark::State &state) noexcept {
     auto out = md::mdarray<T, md::dims<1>>{md::dims<1>{set_num}};
 
     for (auto _ : state) {
-        md::atan2(in1, in2, out);
+        md::atan2_to(in1, in2, out);
     }
 
     state.SetComplexityN(state.range(0));

benchmarks/clip/none/source.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "benchmark/benchmark.h"
-#include "ctmd/clip.hpp"
-#include "ctmd/full.hpp"
+#include "ctmd/ctmd_clip.hpp"
+#include "ctmd/ctmd_full.hpp"
 
 namespace md = ctmd;
 
@@ -19,7 +19,7 @@ template <typename T> inline void test(benchmark::State &state) noexcept {
     auto out = md::mdarray<T, md::dims<1>>{md::dims<1>{set_num}};
 
     for (auto _ : state) {
-        md::clip(in, min, max, out);
+        md::clip_to(in, min, max, out);
     }
 
     state.SetComplexityN(state.range(0));

benchmarks/copy/none/source.hpp

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "benchmark/benchmark.h"
-#include "ctmd/copy.hpp"
-#include "ctmd/full.hpp"
+#include "ctmd/ctmd_copy.hpp"
+#include "ctmd/ctmd_full.hpp"
 
 namespace md = ctmd;
 
@@ -17,7 +17,7 @@ template <typename T> inline void test(benchmark::State &state) noexcept {
     auto out = md::mdarray<T, md::dims<1>>{md::dims<1>{set_num}};
 
     for (auto _ : state) {
-        md::copy(in, out);
+        md::copy_to(in, out);
     }
 
     state.SetComplexityN(state.range(0));