ed.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 ED_H
#define ED_H

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

#ifndef AT1_H
#include "SheafSystem/at1.h"
#include "SheafSystem/tp_space.h"
#endif

namespace fiber_bundle
{

//==============================================================================
// CLASS ED_LITE
//==============================================================================

class SHEAF_DLL_SPEC ed_lite : public at1_lite
{
  //============================================================================
  //============================================================================

public:

  ed_lite();

  ed_lite(const ed_lite& xother);

  ed_lite& operator=(const ed_lite& xother);

  virtual ~ed_lite();

  ed_lite(const row_dofs_type& xrow_dofs);

  ed_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 ed_lite* clone() const;

protected:
private:




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

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;

  bool invariant() const;

protected:
private:

};


//==============================================================================
// CLASS ED
//==============================================================================

class SHEAF_DLL_SPEC ed : public at1
{
  // ===========================================================
  // ===========================================================

public:

  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& xscalar_space_path,
                 bool xauto_access);

protected:

private:



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

public:

  typedef ed_lite volatile_type;

  ed();

  ed(const poset_state_handle* xhost, pod_index_type xhub_id);

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

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

  explicit ed(abstract_poset_member* xother);

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

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

  ed& operator=(const ed& xother);

  ~ed();

  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:

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

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

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

protected:
private:



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

public:

  bool is_ancestor_of(const any* xother) const;

  bool invariant() const;

protected:
private:

};

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

namespace ed_algebra
{

SHEAF_DLL_SPEC vd_value_type dot(const ed& x0, const ed& x1, bool xauto_access);

SHEAF_DLL_SPEC vd_value_type length(const ed& x0, bool xauto_access);

SHEAF_DLL_SPEC void put_length(ed& x0, const vd_value_type& xlength, bool xauto_access);

SHEAF_DLL_SPEC void normalize(const ed& x0, ed& xresult, bool xauto_access);

template <typename T>
void normalize(T& x0, bool xauto_access);

SHEAF_DLL_SPEC vd_value_type dot(const ed_lite& x0, const ed_lite& x1);

SHEAF_DLL_SPEC vd_value_type length(const ed_lite& x0);

SHEAF_DLL_SPEC void put_length(ed_lite& x0, const vd_value_type& xlength);

SHEAF_DLL_SPEC void normalize(const ed_lite& x0, ed_lite& xresult);

template <typename T>
vd_value_type operator*(const T& x0, const T& x1);

template <typename T>
void normalize(T& x0);
  
} // namespace ed_algebra
  
} // namespace fiber_bundle

#endif // ifndef ED_H