• 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 #ifndef MINDSPORE_CORE_OPS_CLIP_H_
17 #define MINDSPORE_CORE_OPS_CLIP_H_
18 #include <memory>
19 
20 #include "ops/primitive_c.h"
21 #include "abstract/abstract_value.h"
22 #include "utils/check_convert_utils.h"
23 
24 namespace mindspore {
25 namespace ops {
26 constexpr auto kNameClip = "Clip";
27 /// \brief Clip defined Clip operator prototype.
28 class MS_CORE_API Clip : public PrimitiveC {
29  public:
30   /// \brief Constructor.
Clip()31   Clip() : PrimitiveC(kNameClip) {}
32 
33   /// \brief Destructor.
34   ~Clip() = default;
35 
36   MS_DECLARE_PARENT(Clip, PrimitiveC);
37 
38   /// \brief Method to init the op's attributes.
39   ///
40   /// \param[in] max Define the upper bound. If value is larger than the upper bound, it will be set as this upper
41   ///            bound.
42   /// \param[in] min Define the lower bound. If value is less than the lower bound, it will be set as this lower bound.
43   void Init(const float max, const float min);
44 
45   /// \brief Method to set max attribute.
46   ///
47   /// \param[in] max Define the upper bound. If value is larger than the upper bound, it will be set as this upper
48   ///            bound.
49   void set_max(const float max);
50 
51   /// \brief Method to set min attribute.
52   ///
53   /// \param[in] min Define the lower bound. If value is less than the lower bound, it will be set as this lower bound.
54   void set_min(const float min);
55 
56   /// \brief Method to get max attribute.
57   ///
58   /// \return a value to indicate upper bound.
59   float get_max() const;
60 
61   /// \brief Method to get min attribute.
62   ///
63   /// \return a value to indicate lower bound.
64   float get_min() const;
65 };
66 
67 using PrimClipPtr = std::shared_ptr<Clip>;
68 }  // namespace ops
69 }  // namespace mindspore
70 
71 #endif  // MINDSPORE_CORE_OPS_CLIP_H_
72