variance_bound_refinement_policy.h

Go to the documentation of this file.

//
// Copyright (c) 2014 Limit Point Systems, Inc. 
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//


#ifndef VARIANCE_BOUND_REFINEMENT_POLICY_H
#define VARIANCE_BOUND_REFINEMENT_POLICY_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef FIELD_REFINEMENT_POLICY_H
#include "SheafSystem/field_refinement_policy.h"
#endif

namespace fields
{

using namespace fiber_bundle;

class SHEAF_DLL_SPEC variance_bound_refinement_policy : public field_refinement_policy
{

  // ===========================================================
  // ===========================================================

public:

  variance_bound_refinement_policy(size_type xrefinement_level_ub = 2,
                                   sec_vd_value_type xvariance_ub = 1.0e-10);

  variance_bound_refinement_policy(const variance_bound_refinement_policy& xother);

  virtual ~variance_bound_refinement_policy();

  sec_vd_value_type variance_ub() const;

  void put_variance_ub(sec_vd_value_type xub);

protected:

  sec_vd_value_type _variance_ub;

private:

  static bool _has_prototype;

  static bool make_prototype();



  // ===========================================================
  // ===========================================================

public:

  virtual bool should_refine(field_refinement_buffer& xbuffer,
                             size_type xrefinement_depth) const;

  virtual const std::string& class_name() const;

  static const std::string& static_class_name();



  // ===========================================================
  // ===========================================================

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual variance_bound_refinement_policy* clone() const;

  virtual variance_bound_refinement_policy& operator=(const field_refinement_policy& xother);

  variance_bound_refinement_policy& operator=(const variance_bound_refinement_policy& xother);

  virtual bool invariant() const;


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
  
} // namespace fields

#endif // ifndef VARIANCE_BOUND_REFINEMENT_POLICY_H