COMPMID-344 Updated doxygen
Change-Id: I32f7b84daa560e460b77216add529c8fa8b327ae
diff --git a/tests/validation/TensorVisitors.h b/tests/validation/TensorVisitors.h
new file mode 100644
index 0000000..a274140
--- /dev/null
+++ b/tests/validation/TensorVisitors.h
@@ -0,0 +1,386 @@
+/*
+ * Copyright (c) 2017 ARM Limited.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+#ifndef __ARM_COMPUTE_TEST_TENSOR_VISITORS_H__
+#define __ARM_COMPUTE_TEST_TENSOR_VISITORS_H__
+
+#include "Tensor.h"
+#include "TensorOperations.h"
+#include "arm_compute/core/Error.h"
+
+#include "boost_wrapper.h"
+
+#include <ostream>
+
+namespace arm_compute
+{
+namespace test
+{
+namespace validation
+{
+namespace tensor_visitors
+{
+// Absolute Difference visitor
+struct absolute_difference_visitor : public boost::static_visitor<>
+{
+public:
+ template <typename T1, typename T2, typename T3>
+ void operator()(const Tensor<T1> &in1, const Tensor<T2> &in2, Tensor<T3> &out) const
+ {
+ tensor_operations::absolute_difference(in1, in2, out);
+ }
+};
+// Arithmetic Addition visitor
+struct arithmetic_addition_visitor : public boost::static_visitor<>
+{
+public:
+ explicit arithmetic_addition_visitor(ConvertPolicy convert_policy)
+ : _policy(convert_policy)
+ {
+ }
+
+ template <typename T1, typename T2, typename T3>
+ void operator()(const Tensor<T1> &in1, const Tensor<T2> &in2, Tensor<T3> &out) const
+ {
+ tensor_operations::arithmetic_addition(in1, in2, out, _policy);
+ }
+
+private:
+ ConvertPolicy _policy;
+};
+// Arithmetic Subtraction visitor
+struct arithmetic_subtraction_visitor : public boost::static_visitor<>
+{
+public:
+ explicit arithmetic_subtraction_visitor(ConvertPolicy convert_policy)
+ : _policy(convert_policy)
+ {
+ }
+
+ template <typename T1, typename T2, typename T3>
+ void operator()(const Tensor<T1> &in1, const Tensor<T2> &in2, Tensor<T3> &out) const
+ {
+ tensor_operations::arithmetic_subtraction(in1, in2, out, _policy);
+ }
+
+private:
+ ConvertPolicy _policy;
+};
+// Depth Convert visitor
+struct depth_convert_visitor : public boost::static_visitor<>
+{
+public:
+ explicit depth_convert_visitor(ConvertPolicy policy, uint32_t shift)
+ : _policy(policy), _shift(shift)
+ {
+ }
+
+ template <typename T1, typename T2>
+ void operator()(const Tensor<T1> &in, Tensor<T2> &out) const
+ {
+ tensor_operations::depth_convert(in, out, _policy, _shift);
+ }
+
+private:
+ ConvertPolicy _policy;
+ uint32_t _shift;
+};
+// GEMM visitor
+struct gemm_visitor : public boost::static_visitor<>
+{
+public:
+ explicit gemm_visitor(const TensorVariant &in1, const TensorVariant &in2, const TensorVariant &in3, float alpha, float beta)
+ : _in1(in1), _in2(in2), _in3(in3), _alpha(alpha), _beta(beta)
+ {
+ }
+
+ template <typename T>
+ void operator()(Tensor<T> &out) const
+ {
+ const Tensor<T> &in1 = boost::get<Tensor<T>>(_in1);
+ const Tensor<T> &in2 = boost::get<Tensor<T>>(_in2);
+ const Tensor<T> &in3 = boost::get<Tensor<T>>(_in3);
+ tensor_operations::gemm(in1, in2, in3, out, _alpha, _beta);
+ }
+
+private:
+ const TensorVariant &_in1, &_in2, &_in3;
+ float _alpha;
+ float _beta;
+};
+// Pixel-wise Multiplication visitor
+struct pixel_wise_multiplication_visitor : public boost::static_visitor<>
+{
+public:
+ explicit pixel_wise_multiplication_visitor(float scale, ConvertPolicy convert_policy, RoundingPolicy rounding_policy)
+ : _scale(scale), _convert_policy(convert_policy), _rounding_policy(rounding_policy)
+ {
+ }
+
+ template <typename T1, typename T2, typename T3>
+ void operator()(const Tensor<T1> &in1, const Tensor<T2> &in2, Tensor<T3> &out) const
+ {
+ tensor_operations::pixel_wise_multiplication(in1, in2, out, _scale, _convert_policy, _rounding_policy);
+ }
+
+private:
+ float _scale;
+ ConvertPolicy _convert_policy;
+ RoundingPolicy _rounding_policy;
+};
+// Fixed Point Pixel-wise Multiplication visitor
+struct fixed_point_pixel_wise_multiplication_visitor : public boost::static_visitor<>
+{
+public:
+ explicit fixed_point_pixel_wise_multiplication_visitor(const TensorVariant &in1, const TensorVariant &in2, float scale, ConvertPolicy convert_policy, RoundingPolicy rounding_policy)
+ : _in1(in1), _in2(in2), _scale(scale), _convert_policy(convert_policy), _rounding_policy(rounding_policy)
+ {
+ }
+
+ template <typename T, typename = typename std::enable_if<std::is_integral<T>::value>::type>
+ void operator()(Tensor<T> &out) const
+ {
+ const Tensor<T> &in1 = boost::get<Tensor<T>>(_in1);
+ const Tensor<T> &in2 = boost::get<Tensor<T>>(_in2);
+ tensor_operations::fixed_point_pixel_wise_multiplication(in1, in2, out, _scale, _convert_policy, _rounding_policy);
+ }
+ template < typename T, typename std::enable_if < !std::is_integral<T>::value, int >::type = 0 >
+ void operator()(Tensor<T> &out) const
+ {
+ ARM_COMPUTE_ERROR("NOT SUPPORTED!");
+ }
+
+private:
+ const TensorVariant &_in1;
+ const TensorVariant &_in2;
+ float _scale;
+ ConvertPolicy _convert_policy;
+ RoundingPolicy _rounding_policy;
+};
+// Threshold operation
+void threshold_operation(const Tensor<uint8_t> &in, Tensor<uint8_t> &out, uint8_t threshold, uint8_t false_value, uint8_t true_value, ThresholdType type, uint8_t upper)
+{
+ tensor_operations::threshold(in, out, threshold, false_value, true_value, type, upper);
+}
+// Activation layer visitor
+struct activation_layer_visitor : public boost::static_visitor<>
+{
+public:
+ explicit activation_layer_visitor(const TensorVariant &in, ActivationLayerInfo act_info)
+ : _in(in), _act_info(act_info)
+ {
+ }
+
+ template <typename T>
+ void operator()(Tensor<T> &out) const
+ {
+ const auto &in = boost::get<Tensor<T>>(_in);
+ tensor_operations::activation_layer(in, out, _act_info);
+ }
+
+private:
+ const TensorVariant &_in;
+ const ActivationLayerInfo _act_info;
+};
+// Batch Normalization Layer visitor
+struct batch_normalization_layer_visitor : public boost::static_visitor<>
+{
+public:
+ explicit batch_normalization_layer_visitor(const TensorVariant &in, const TensorVariant &mean, const TensorVariant &var, const TensorVariant &beta, const TensorVariant &gamma, float epsilon,
+ int fixed_point_position = 0)
+ : _in(in), _mean(mean), _var(var), _beta(beta), _gamma(gamma), _epsilon(epsilon), _fixed_point_position(fixed_point_position)
+ {
+ }
+
+ template <typename T>
+ void operator()(Tensor<T> &out) const
+ {
+ const Tensor<T> &in = boost::get<Tensor<T>>(_in);
+ const Tensor<T> &mean = boost::get<Tensor<T>>(_mean);
+ const Tensor<T> &var = boost::get<Tensor<T>>(_var);
+ const Tensor<T> &beta = boost::get<Tensor<T>>(_beta);
+ const Tensor<T> &gamma = boost::get<Tensor<T>>(_gamma);
+ tensor_operations::batch_normalization_layer(in, out, mean, var, beta, gamma, _epsilon, _fixed_point_position);
+ }
+
+private:
+ const TensorVariant &_in, &_mean, &_var, &_beta, &_gamma;
+ float _epsilon;
+ int _fixed_point_position;
+};
+// Convolution Layer visitor
+struct convolution_layer_visitor : public boost::static_visitor<>
+{
+public:
+ explicit convolution_layer_visitor(const TensorVariant &in, const TensorVariant &weights, const TensorVariant &bias, PadStrideInfo conv_info)
+ : _in(in), _weights(weights), _bias(bias), _conv_info(conv_info)
+ {
+ }
+
+ template <typename T>
+ void operator()(Tensor<T> &out) const
+ {
+ const Tensor<T> &in = boost::get<Tensor<T>>(_in);
+ const Tensor<T> &weights = boost::get<Tensor<T>>(_weights);
+ const Tensor<T> &bias = boost::get<Tensor<T>>(_bias);
+ tensor_operations::convolution_layer(in, weights, bias, out, _conv_info);
+ }
+
+private:
+ const TensorVariant &_in;
+ const TensorVariant &_weights;
+ const TensorVariant &_bias;
+ PadStrideInfo _conv_info;
+};
+
+struct fully_connected_layer_visitor : public boost::static_visitor<>
+{
+public:
+ explicit fully_connected_layer_visitor(const TensorVariant &in, const TensorVariant &weights, const TensorVariant &bias)
+ : _in(in), _weights(weights), _bias(bias)
+ {
+ }
+ template <typename T>
+ void operator()(Tensor<T> &out) const
+ {
+ const Tensor<T> &in = boost::get<Tensor<T>>(_in);
+ const Tensor<T> &weights = boost::get<Tensor<T>>(_weights);
+ const Tensor<T> &bias = boost::get<Tensor<T>>(_bias);
+ tensor_operations::fully_connected_layer(in, weights, bias, out);
+ }
+
+private:
+ const TensorVariant &_in;
+ const TensorVariant &_weights;
+ const TensorVariant &_bias;
+};
+
+// Normalization Layer visitor
+struct normalization_layer_visitor : public boost::static_visitor<>
+{
+public:
+ explicit normalization_layer_visitor(const TensorVariant &in, NormalizationLayerInfo norm_info)
+ : _in(in), _norm_info(norm_info)
+ {
+ }
+
+ template <typename T>
+ void operator()(Tensor<T> &out) const
+ {
+ const Tensor<T> &in = boost::get<Tensor<T>>(_in);
+ tensor_operations::normalization_layer(in, out, _norm_info);
+ }
+
+private:
+ const TensorVariant &_in;
+ NormalizationLayerInfo _norm_info;
+};
+// Pooling layer
+struct pooling_layer_visitor : public boost::static_visitor<>
+{
+public:
+ explicit pooling_layer_visitor(const TensorVariant &in, PoolingLayerInfo pool_info, int fixed_point_position = 0)
+ : _in(in), _pool_info(pool_info), _fixed_point_position(fixed_point_position)
+ {
+ }
+
+ template <typename T>
+ void operator()(Tensor<T> &out) const
+ {
+ const Tensor<T> &in = boost::get<Tensor<T>>(_in);
+ tensor_operations::pooling_layer(in, out, _pool_info, _fixed_point_position);
+ }
+
+private:
+ const TensorVariant &_in;
+ PoolingLayerInfo _pool_info;
+ int _fixed_point_position;
+};
+// Softmax Layer visitor
+struct softmax_layer_visitor : public boost::static_visitor<>
+{
+public:
+ explicit softmax_layer_visitor(const TensorVariant &in)
+ : _in(in)
+ {
+ }
+
+ template <typename T>
+ void operator()(Tensor<T> &out) const
+ {
+ const auto &in = boost::get<Tensor<T>>(_in);
+ tensor_operations::softmax_layer(in, out);
+ }
+
+private:
+ const TensorVariant &_in;
+};
+// Fixed Point operations visitor
+struct fixed_point_operation_visitor : public boost::static_visitor<>
+{
+public:
+ explicit fixed_point_operation_visitor(const TensorVariant &in, FixedPointOp op)
+ : _in(in), _op(op)
+ {
+ }
+
+ template <typename T, typename std::enable_if<std::is_integral<T>::value, int>::type = 0>
+ void operator()(Tensor<T> &out) const
+ {
+ const Tensor<T> &in = boost::get<Tensor<T>>(_in);
+ tensor_operations::fixed_point_operation(in, out, _op);
+ }
+ template < typename T, typename std::enable_if < !std::is_integral<T>::value, int >::type = 0 >
+ void operator()(Tensor<T> &out) const
+ {
+ ARM_COMPUTE_ERROR("NOT SUPPORTED!");
+ }
+
+private:
+ const TensorVariant &_in;
+ FixedPointOp _op;
+};
+// Print Tensor visitor
+struct print_visitor : public boost::static_visitor<>
+{
+public:
+ explicit print_visitor(std::ostream &out)
+ : _out(out)
+ {
+ }
+
+ template <typename T>
+ void operator()(const Tensor<T> &in) const
+ {
+ tensor_operations::print(in, _out);
+ }
+
+private:
+ std::ostream &_out;
+};
+} // namespace tensor_visitors
+} // namespace validation
+} // namespace test
+} // namespace arm_compute
+
+#endif /* __ARM_COMPUTE_TEST_TENSOR_VISITORS_H__ */