1 /** 2 * Copyright 2021 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 #ifndef MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_CACHE_NODE_H_ 17 #define MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_CACHE_NODE_H_ 18 19 #include <memory> 20 #include <string> 21 #include <vector> 22 23 #include "minddata/dataset/engine/ir/datasetops/dataset_node.h" 24 25 namespace mindspore { 26 namespace dataset { 27 class CacheNode : public DatasetNode { 28 public: 29 /// \brief Constructor 30 CacheNode(std::shared_ptr<DatasetNode> child, std::shared_ptr<SamplerObj> sampler, 31 std::shared_ptr<DatasetCache> cache); 32 33 /// \brief Destructor 34 ~CacheNode() = default; 35 36 /// \brief Node name getter 37 /// \return Name of the current node Name()38 std::string Name() const override { return kCacheNode; } 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>> *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 Base-class override for accepting IRNodePass visitor 58 /// \param[in] p The node to visit 59 /// \param[out] modified Indicator if the node was modified 60 /// \return Status of the node visit 61 Status Accept(IRNodePass *const p, bool *const modified) override; 62 63 /// \brief Base-class override for accepting IRNodePass visitor 64 /// \param[in] p The node to visit 65 /// \param[out] modified Indicator if the node was modified 66 /// \return Status of the node visit 67 Status AcceptAfter(IRNodePass *const p, bool *const modified) override; 68 69 private: 70 std::shared_ptr<SamplerObj> sampler_; 71 }; 72 } // namespace dataset 73 } // namespace mindspore 74 75 #endif // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_CACHE_NODE_H_ 76