1 /** 2 * Copyright 2020-2022 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 class ProjectNode : public DatasetNode { 29 public: 30 /// \brief Constructor 31 explicit ProjectNode(std::shared_ptr<DatasetNode> child, const std::vector<std::string> &columns); 32 33 /// \brief Destructor 34 ~ProjectNode() override = default; 35 36 /// \brief Node name getter 37 /// \return Name of the current node Name()38 std::string Name() const override { return kProjectNode; } 39 40 /// \brief Print the description 41 /// \param out - The output stream to write output to 42 void Print(std::ostream &out) const override; 43 44 /// \brief Copy the node to a new object 45 /// \return A shared pointer to the new copy 46 std::shared_ptr<DatasetNode> Copy() override; 47 48 /// \brief a base class override function to create the required runtime dataset op objects for this class 49 /// \param node_ops - A vector containing shared pointer to the Dataset Ops that this object will create 50 /// \return Status Status::OK() if build successfully 51 Status Build(std::vector<std::shared_ptr<DatasetOp>> *const node_ops) override; 52 53 /// \brief Parameters validation 54 /// \return Status Status::OK() if all the parameters are valid 55 Status ValidateParams() override; 56 57 /// \brief Getter functions Columns()58 const std::vector<std::string> &Columns() const { return columns_; } 59 60 /// \brief Get the arguments of node 61 /// \param[out] out_json JSON string of all attributes 62 /// \return Status of the function 63 Status to_json(nlohmann::json *out_json) override; 64 65 /// \brief Function for read dataset operation from json 66 /// \param[in] json_obj The JSON object to be deserialized 67 /// \param[in] ds dataset node constructed 68 /// \param[out] result Deserialized dataset after the operation 69 /// \return Status The status code returned 70 static Status from_json(nlohmann::json json_obj, std::shared_ptr<DatasetNode> ds, 71 std::shared_ptr<DatasetNode> *result); 72 73 /// \brief Base-class override for accepting IRNodePass visitor 74 /// \param[in] p The node to visit 75 /// \param[out] modified Indicator if the node was modified 76 /// \return Status of the node visit 77 Status Accept(IRNodePass *const p, bool *const modified) override; 78 79 /// \brief Base-class override for accepting IRNodePass visitor 80 /// \param[in] p The node to visit 81 /// \param[out] modified Indicator if the node was modified 82 /// \return Status of the node visit 83 Status AcceptAfter(IRNodePass *const p, bool *const modified) override; 84 85 private: 86 std::vector<std::string> columns_; 87 }; 88 } // namespace dataset 89 } // namespace mindspore 90 #endif // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_PROJECT_NODE_H_ 91