Home | History | Annotate | Download | only in reduce
      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 capturing an opportunity to apply a reducing transformation.
     24 class ReductionOpportunity {
     25  public:
     26   ReductionOpportunity() = default;
     27   virtual ~ReductionOpportunity() = default;
     28 
     29   // Determines whether the opportunity can be applied; it may have been viable
     30   // when discovered but later disabled by the application of some other
     31   // reduction opportunity.
     32   virtual bool PreconditionHolds() = 0;
     33 
     34   // A no-op if PreconditoinHolds() returns false; otherwise applies the
     35   // opportunity.
     36   void TryToApply();
     37 
     38  protected:
     39   // Apply the reduction opportunity.
     40   virtual void Apply() = 0;
     41 };
     42 
     43 }  // namespace reduce
     44 }  // namespace spvtools
     45 
     46 #endif  // SOURCE_REDUCE_REDUCTION_OPPORTUNITY_H_
     47