met.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 MET_H
#define MET_H

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

#ifndef ST2_H
#include "SheafSystem/st2.h"
#endif

namespace fiber_bundle
{

//==============================================================================
// CLASS MET_LITE
//==============================================================================

class SHEAF_DLL_SPEC met_lite : public st2_lite
{
  //============================================================================
  //============================================================================

public:

  met_lite();

  met_lite(const met_lite& xother);

  met_lite& operator=(const met_lite& xother);

  virtual ~met_lite();

  met_lite(const row_dofs_type& xrow_dofs);

  met_lite& operator=(const row_dofs_type& xrow_dofs);

protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:

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

  static const std::string& static_class_name();
  
  virtual met_lite* clone() const;

protected:
private:



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

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;

  bool invariant() const;

protected:
private:

};


//==============================================================================
// CLASS MET
//==============================================================================

class SHEAF_DLL_SPEC met : public st2
{

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

public:

  typedef stp_space host_type;

  static const poset_path& standard_schema_path();

  static void make_standard_schema(namespace_poset& xns);

  static host_type& new_host(namespace_type& xns, 
                 const poset_path& xhost_path, 
                 const poset_path& xschema_path,
                 const poset_path& xvector_space_path,
                 bool xauto_access);

protected:

private:



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

public:

  typedef met_lite volatile_type;

  met();

  met(const poset_state_handle* xhost, pod_index_type xhub_id);

  met(const poset_state_handle* xhost, const scoped_index& xid);

  met(const poset_state_handle* xhost, const std::string& xname);

  explicit met(abstract_poset_member* xother);

  met(poset_state_handle* xhost, bool xauto_access = true);

  virtual met& operator=(const abstract_poset_member& xother);

  met& operator=(const met& xother);

  ~met();

  virtual const volatile_type& lite_prototype() const;

  virtual volatile_type* lite_type() const;


protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:

protected:

private:



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

public:

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

  static const std::string& static_class_name();
  
  virtual met* clone() const;

  inline met* clone(bool xnew_state, bool xauto_access = true) const
  {
    return static_cast<met*>(st2::clone(xnew_state, xauto_access));
  }

protected:
private:



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

public:

  bool is_ancestor_of(const any* xother) const;


  bool invariant() const;

protected:
private:

};

//==============================================================================
// NON-MEMBER FUNCTIONS
//==============================================================================

class ed;
class ed_lite;

namespace met_algebra
{

SHEAF_DLL_SPEC void raise(const met& xmetric, const ed& xcovector, ed& xresult,
              bool xauto_access);

SHEAF_DLL_SPEC void lower(const met& xmetric, const ed& xvector, ed& xresult,
              bool xauto_access);

SHEAF_DLL_SPEC void raise(const met_lite& xmetric, const ed_lite& xcovector, ed_lite& xresult);

SHEAF_DLL_SPEC ed_lite* raise(const met_lite& xmetric, const ed_lite& xcovector);

SHEAF_DLL_SPEC void lower(const met_lite& xmetric, const ed_lite& xvector, ed_lite& xresult);

SHEAF_DLL_SPEC ed_lite* lower(const met_lite& xmetric, const ed_lite& xvector);

} // namespace met_algebra

} // namespace fiber_bundle

#endif // ifndef MET_H