• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2  * Copyright 2020 Huawei Technologies Co., Ltd
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_PROJECT_NODE_H_
18 #define MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_PROJECT_NODE_H_
19 
20 #include <memory>
21 #include <string>
22 #include <vector>
23 
24 #include "minddata/dataset/engine/ir/datasetops/dataset_node.h"
25 
26 namespace mindspore {
27 namespace dataset {
28 
29 class ProjectNode : public DatasetNode {
30  public:
31   /// \brief Constructor
32   explicit ProjectNode(std::shared_ptr<DatasetNode> child, const std::vector<std::string> &columns);
33 
34   /// \brief Destructor
35   ~ProjectNode() = default;
36 
37   /// \brief Node name getter
38   /// \return Name of the current node
Name()39   std::string Name() const override { return kProjectNode; }
40 
41   /// \brief Print the description
42   /// \param out - The output stream to write output to
43   void Print(std::ostream &out) const override;
44 
45   /// \brief Copy the node to a new object
46   /// \return A shared pointer to the new copy
47   std::shared_ptr<DatasetNode> Copy() override;
48 
49   /// \brief a base class override function to create the required runtime dataset op objects for this class
50   /// \param node_ops - A vector containing shared pointer to the Dataset Ops that this object will create
51   /// \return Status Status::OK() if build successfully
52   Status Build(std::vector<std::shared_ptr<DatasetOp>> *const node_ops) override;
53 
54   /// \brief Parameters validation
55   /// \return Status Status::OK() if all the parameters are valid
56   Status ValidateParams() override;
57 
58   /// \brief Getter functions
Columns()59   const std::vector<std::string> &Columns() const { return columns_; }
60 
61   /// \brief Get the arguments of node
62   /// \param[out] out_json JSON string of all attributes
63   /// \return Status of the function
64   Status to_json(nlohmann::json *out_json) override;
65 
66   /// \brief Function for read dataset operation from json
67   /// \param[in] json_obj The JSON object to be deserialized
68   /// \param[in] ds dataset node constructed
69   /// \param[out] result Deserialized dataset after the operation
70   /// \return Status The status code returned
71   static Status from_json(nlohmann::json json_obj, std::shared_ptr<DatasetNode> ds,
72                           std::shared_ptr<DatasetNode> *result);
73 
74  private:
75   std::vector<std::string> columns_;
76 };
77 
78 }  // namespace dataset
79 }  // namespace mindspore
80 #endif  // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_PROJECT_NODE_H_
81