• 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_ZIP_NODE_H_
18 #define MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_ZIP_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 ZipNode : public DatasetNode {
30  public:
31   /// \brief Constructor
32   explicit ZipNode(const std::vector<std::shared_ptr<DatasetNode>> &datasets);
33 
34   /// \brief Destructor
35   ~ZipNode() = default;
36 
37   /// \brief Node name getter
38   /// \return Name of the current node
Name()39   std::string Name() const override { return kZipNode; }
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 Base-class override for GetDatasetSize
59   /// \param[in] size_getter Shared pointer to DatasetSizeGetter
60   /// \param[in] estimate This is only supported by some of the ops and it's used to speed up the process of getting
61   ///     dataset size at the expense of accuracy.
62   /// \param[out] dataset_size the size of the dataset
63   /// \return Status of the function
64   Status GetDatasetSize(const std::shared_ptr<DatasetSizeGetter> &size_getter, bool estimate,
65                         int64_t *dataset_size) 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 Accept(IRNodePass *const p, bool *const modified) override;
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 AcceptAfter(IRNodePass *const p, bool *const modified) override;
78 
79   /// \brief Function to read dataset in json
80   /// \param[in] datasets A vector of datasets for Zip input
81   /// \param[out] result Deserialized dataset
82   /// \return Status The status code returned
83   static Status from_json(std::vector<std::shared_ptr<DatasetNode>> datasets, std::shared_ptr<DatasetNode> *result);
84 
85  private:
86   std::vector<std::shared_ptr<DatasetNode>> datasets_;
87 };
88 
89 }  // namespace dataset
90 }  // namespace mindspore
91 #endif  // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_IR_DATASETOPS_ZIP_NODE_H_
92