• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2018 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //     http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef SOURCE_REDUCE_REDUCTION_OPPORTUNITY_H_
16 #define SOURCE_REDUCE_REDUCTION_OPPORTUNITY_H_
17 
18 #include "spirv-tools/libspirv.hpp"
19 
20 namespace spvtools {
21 namespace reduce {
22 
23 // Abstract class: an opportunity to apply a reducing transformation.
24 class ReductionOpportunity {
25  public:
26   ReductionOpportunity() = default;
27   virtual ~ReductionOpportunity() = default;
28 
29   // Returns true if this opportunity has not been disabled by the application
30   // of another conflicting opportunity.
31   virtual bool PreconditionHolds() = 0;
32 
33   // Applies the opportunity, mutating the module from which the opportunity was
34   // created. It is a no-op if PreconditionHolds() returns false.
35   void TryToApply();
36 
37  protected:
38   // Applies the opportunity, mutating the module from which the opportunity was
39   // created.
40   // Precondition: PreconditionHolds() must return true.
41   virtual void Apply() = 0;
42 };
43 
44 }  // namespace reduce
45 }  // namespace spvtools
46 
47 #endif  // SOURCE_REDUCE_REDUCTION_OPPORTUNITY_H_
48