arm_compute/runtime/NEON/functions/NEGEMMLowpAssemblyMatrixMultiplyCore.h

/*
 * Copyright (c) 2017-2020 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_NEGEMMLOWPASSEMBLYMATRIXMULTIPLYCORE_H
#define ARM_COMPUTE_NEGEMMLOWPASSEMBLYMATRIXMULTIPLYCORE_H

#include "arm_compute/runtime/IFunction.h"
#include "arm_compute/runtime/IMemoryManager.h"
#include "arm_compute/runtime/MemoryGroup.h"
#include "arm_compute/runtime/NEON/functions/NEGEMMAssemblyDispatch.h"
#include "arm_compute/runtime/Tensor.h"

#include <memory>

namespace arm_compute
{
// Forward declarations
class ITensor;
class NEGEMMInterleave4x4Kernel;
class NEGEMMTranspose1xWKernel;
class NEGEMMLowpMatrixMultiplyKernel;

/** Basic function to execute matrix multiply assembly kernels. */
class NEGEMMLowpAssemblyMatrixMultiplyCore : public IFunction
{
public:
    /** Constructor */
    NEGEMMLowpAssemblyMatrixMultiplyCore(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
    /** Destructor */
    ~NEGEMMLowpAssemblyMatrixMultiplyCore();

    /** Initialise the kernel's inputs, output
     *
     * @param[in]  a      First input tensor  (Matrix A). Data type supported: U8, S8.
     * @param[in]  b      Second input tensor (Matrix B). Data type supported: same as @p a
     * @param[in]  c      Third input tensor (Matrix C). Data type supported: same as @p a
     * @param[out] output Output tensor. Data type supported: Data type supported: U32, S32
     */
    void configure(const ITensor *a, const ITensor *b, const ITensor *c, ITensor *output);

    // Inherited methods overridden:
    void run() override;

private:
    MemoryGroup                                     _memory_group;
    NEGEMMAssemblyDispatch                          _asm_glue;
    std::unique_ptr<NEGEMMLowpMatrixMultiplyKernel> _mm_kernel;
    std::unique_ptr<NEGEMMInterleave4x4Kernel>      _mtx_a_reshape_kernel;
    std::unique_ptr<NEGEMMTranspose1xWKernel>       _mtx_b_reshape_kernel;
    Tensor                                          _tmp_a;
    Tensor                                          _tmp_b;
};
} // namespace arm_compute
#endif /*ARM_COMPUTE_NEGEMMLOWPASSEMBLYMATRIXMULTIPLYCORE_H */