arm_compute/graph/nodes/ConcatenateLayerNode.h

/*
 * Copyright (c) 2018-2019 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_GRAPH_CONCATENATE_LAYER_NODE_H
#define ARM_COMPUTE_GRAPH_CONCATENATE_LAYER_NODE_H

#include "arm_compute/graph/INode.h"

namespace arm_compute
{
namespace graph
{
/** Concatenation Layer node */
class ConcatenateLayerNode final : public INode
{
public:
    /** Constructor
     *
     * @param[in] total_nodes       Number of nodes that will get concatenated
     * @param[in] concat_descriptor Concatenate Layer Descriptor
     */
    ConcatenateLayerNode(unsigned int total_nodes, descriptors::ConcatLayerDescriptor concat_descriptor);
    /** Computes concatenations output descriptor
     *
     * @param[in] input_descriptors Input descriptors
     * @param[in] axis              Concatenation axis
     *
     * @return Expected output descriptor
     */
    static TensorDescriptor compute_output_descriptor(const std::vector<TensorDescriptor> &input_descriptors,
                                                      DataLayoutDimension                  axis);
    /** Disables or not the depth concatenate node
     *
     * @warning This is used when concatenate is performed using sub-tensors, where this node is used as a placeholder.
     *
     * @param[in] is_enabled If true a backend function is created to perform the concatenation (involves copying),
     *                       while if false, no function is created and we assume that sub-tensors are properly set to simulate
     *                       a zero copy operation.
     */
    void set_enabled(bool is_enabled);
    /** Enabled parameter accessor
     *
     * @return True if a backend function is to be created else false
     */
    bool is_enabled() const;
    /** Concatenation axis parameter accessor
     *
     * @return Concatenation axis
     */
    DataLayoutDimension concatenation_axis() const;

    /** Concatenation output quantization info accessor
     *
     * @return Output quantization info
     */
    QuantizationInfo output_quantization_info() const;

    // Inherited overridden methods:
    NodeType         type() const override;
    bool             forward_descriptors() override;
    TensorDescriptor configure_output(size_t idx) const override;
    void             accept(INodeVisitor &v) override;

private:
    unsigned int                       _total_nodes;
    descriptors::ConcatLayerDescriptor _concat_descriptor;
    bool                               _is_enabled;
};
} // namespace graph
} // namespace arm_compute
#endif /* ARM_COMPUTE_GRAPH_CONCATENATE_LAYER_NODE_H */