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_FILTER_NODE_H_ 18 #define MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_FILTER_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 FilterNode : public DatasetNode { 30 public: 31 /// \brief Constructor 32 FilterNode(std::shared_ptr<DatasetNode> child, std::shared_ptr<TensorOp> predicate, 33 std::vector<std::string> input_columns = {}); 34 35 /// \brief Destructor 36 ~FilterNode() = default; 37 38 /// \brief Node name getter 39 /// \return Name of the current node Name()40 std::string Name() const override { return kFilterNode; } 41 42 /// \brief Print the description 43 /// \param out - The output stream to write output to 44 void Print(std::ostream &out) const override; 45 46 /// \brief Copy the node to a new object 47 /// \return A shared pointer to the new copy 48 std::shared_ptr<DatasetNode> Copy() override; 49 50 /// \brief a base class override function to create the required runtime dataset op objects for this class 51 /// \param node_ops - A vector containing shared pointer to the Dataset Ops that this object will create 52 /// \return Status Status::OK() if build successfully 53 Status Build(std::vector<std::shared_ptr<DatasetOp>> *const node_ops) override; 54 55 /// \brief Parameters validation 56 /// \return Status Status::OK() if all the parameters are valid 57 Status ValidateParams() override; 58 IsSizeDefined()59 bool IsSizeDefined() override { return false; }; 60 61 /// \brief Base-class override for accepting IRNodePass visitor 62 /// \param[in] p The node to visit 63 /// \param[out] modified Indicator if the node was modified 64 /// \return Status of the node visit 65 Status Accept(IRNodePass *const p, bool *const modified) override; 66 67 /// \brief Base-class override for accepting IRNodePass visitor 68 /// \param[in] p The node to visit 69 /// \param[out] modified Indicator if the node was modified 70 /// \return Status of the node visit 71 Status AcceptAfter(IRNodePass *const p, bool *const modified) override; 72 73 /// \brief Getter functions Predicate()74 const std::shared_ptr<TensorOp> &Predicate() const { return predicate_; } InputColumns()75 const std::vector<std::string> &InputColumns() const { return input_columns_; } 76 77 /// \brief Get the arguments of node 78 /// \param[out] out_json JSON string of all attributes 79 /// \return Status of the function 80 Status to_json(nlohmann::json *out_json) override; 81 82 private: 83 std::shared_ptr<TensorOp> predicate_; 84 std::vector<std::string> input_columns_; 85 }; 86 87 } // namespace dataset 88 } // namespace mindspore 89 #endif // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_FILTER_NODE_H_ 90