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 class FilterNode : public DatasetNode { 29 public: 30 /// \brief Constructor 31 FilterNode(std::shared_ptr<DatasetNode> child, std::shared_ptr<TensorOp> predicate, 32 std::vector<std::string> input_columns = {}); 33 34 /// \brief Destructor 35 ~FilterNode() override = default; 36 37 /// \brief Node name getter 38 /// \return Name of the current node Name()39 std::string Name() const override { return kFilterNode; } 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 IsSizeDefined()58 bool IsSizeDefined() override { return false; }; 59 60 /// \brief Base-class override for accepting IRNodePass visitor 61 /// \param[in] p The node to visit 62 /// \param[out] modified Indicator if the node was modified 63 /// \return Status of the node visit 64 Status Accept(IRNodePass *const p, bool *const modified) override; 65 66 /// \brief Base-class override for accepting IRNodePass visitor 67 /// \param[in] p The node to visit 68 /// \param[out] modified Indicator if the node was modified 69 /// \return Status of the node visit 70 Status AcceptAfter(IRNodePass *const p, bool *const modified) override; 71 72 /// \brief Getter functions Predicate()73 const std::shared_ptr<TensorOp> &Predicate() const { return predicate_; } InputColumns()74 const std::vector<std::string> &InputColumns() const { return input_columns_; } 75 76 /// \brief Get the arguments of node 77 /// \param[out] out_json JSON string of all attributes 78 /// \return Status of the function 79 Status to_json(nlohmann::json *out_json) override; 80 81 private: 82 std::shared_ptr<TensorOp> predicate_; 83 std::vector<std::string> input_columns_; 84 }; 85 } // namespace dataset 86 } // namespace mindspore 87 #endif // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_FILTER_NODE_H_ 88