summaryrefslogtreecommitdiff
path: root/runtimes/neurun/core/include/exec/IExecutor.h
blob: eb4f5e302848a137390f51cb697bd9ed77d2940d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * 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  IExecutor.h
 * @brief This file defines interface of Executor
 */
#ifndef __NEURUN_EXEC_I_EXECUTOR_H_
#define __NEURUN_EXEC_I_EXECUTOR_H_

#include "model/Model.h"
#include "IFunction.h"
#include "IODescription.h"
#include "model/OperationIndexMap.h"

namespace neurun
{
namespace exec
{
class IExecutionObserver;
/**
 * @brief Struct to define interface of Executor
 */
struct IExecutor
{
  /**
   * @brief Construct a new IExecutor object
   */
  IExecutor() = default;
  /**
   * @brief Destroy the IExecutor object
   */
  virtual ~IExecutor() = default;

  /**
   * @brief Returns model object
   *
   * @return Model object
   */
  virtual const model::Model &model() = 0;

  /**
   * @brief     Set an ordering on operations
   * @param[in] ranks   The table encoding the ordering
   */
  virtual void setIndexedRanks(std::shared_ptr<model::OperationIndexMap<int64_t>>) = 0;

  /**
   * @brief     Start execution
   * @param[in] desc Input and output description
   * @note      This method should be thread-safe
   */
  virtual void execute(const IODescription &desc) = 0;
};

} // namespace exec
} // namespace neurun

#endif // __NEURUN_EXEC_I_EXECUTOR_H_