tp.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 TP_H
#define TP_H

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

#ifndef VD_H
#include "SheafSystem/vd.h"
#endif

#ifndef TENSOR_VARIANCE_H
#include "SheafSystem/tensor_variance.h"
#endif

#ifndef TP_TABLE_DOFS_TYPE_H
#include "SheafSystem/tp_table_dofs_type.h"
#endif
 
 
namespace fiber_bundle
{
  //
  // Forward declarations
  //

  class tp_space;
  class at1;

//==============================================================================
// CLASS TP_LITE
//==============================================================================

class SHEAF_DLL_SPEC tp_lite : public vd_lite
{
  //============================================================================
  //============================================================================

public:

  typedef tp_table_dofs_type table_dofs_type;

  typedef vd_lite vector_space_type;

  enum static_const_int {P = -1};  

  tp_lite();

  tp_lite(const tp_lite& xother);

  tp_lite& operator=(const tp_lite& xother);

  virtual ~tp_lite();

  tp_lite(const row_dofs_type& xrow_dofs);

  tp_lite& operator=(const row_dofs_type& xrow_dofs);

  virtual int p() const;

  virtual int dd() const;

  virtual pod_index_type vector_space_index() const;

  table_dofs_type table_dofs() const;

protected:
private:



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

public:

  virtual int d() const;

protected:
private:



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

public:
protected:
private:



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

public:

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

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

protected:
private:



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

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;


  bool invariant() const;

protected:
private:

};


//==============================================================================
// CLASS TP
//==============================================================================

class SHEAF_DLL_SPEC tp : public vd
{

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

public:

  typedef tp_space host_type;

  typedef at1 vector_space_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,
                 int xp,
                 const poset_path& xvector_space_path,
                 bool xauto_access);

protected:

private:

 

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

public:

  // Typedefs:

  typedef tp_lite volatile_type;

  typedef tp_table_dofs_type table_dofs_type;

  tp();

  tp(const poset_state_handle* xhost, pod_index_type xhub_id);

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

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

  explicit tp(abstract_poset_member* xother);

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

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

  tp& operator=(const tp& xother);

  virtual ~tp();

  enum static_const_int {P = -1};  

  virtual int p() const;

  int p(bool xauto_access) const;

  virtual int dd() const;

  virtual int dd(bool xauto_access) const;

  poset_path vector_space_path() const;

  poset_path vector_space_path(bool xauto_access) const;

  virtual tp_space& vector_space() const;

  virtual tp_space& vector_space(bool xauto_access) const;

  static const std::string create_tensor_space_name(const std::string& xvector_space_name, const std::string& xname);

  virtual const volatile_type& lite_prototype() const;

  virtual volatile_type* lite_type() const;

  virtual tensor_variance variance(bool xauto_access) const;

  virtual bool variance(int xi, bool xauto_access) const;

  void put_variance(const tensor_variance& xvariance, bool xauto_access);

  void put_variance(int xi, bool xvariance, bool xauto_access);
    
  virtual bool is_covariant(bool xauto_access) const;
    
  virtual bool is_covariant(int xi, bool xauto_access) const;
   
  virtual void put_is_covariant(bool xauto_access);
  
  void put_is_covariant(int xi, bool xauto_access);
 
  virtual bool is_contravariant(bool xauto_access) const;
 
  virtual bool is_contravariant(int xi, bool xauto_access) const;
   
  virtual void put_is_contravariant(bool xauto_access);  
  
  void put_is_contravariant(int xi, bool xauto_access);

protected:

private:



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

public:

//   ///
//   /// True if this is a covector, false if it is a vector.
//   ///
//   virtual bool is_dual(bool xauto_access) const;

//   ///
//   /// Set the duality of this to that of xother if
//   /// xis_opposite is false and to the opposite of
//   /// xother if xis_opposite is true. 
//   ///
//   virtual void put_is_dual(const vd& xother, bool xis_opposite, bool xauto_access);

protected:
private:


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

public:

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

  static const std::string& static_class_name();

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

protected:
private:



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

public:

  host_type* host() const;

  virtual bool host_is_ancestor_of(const poset_state_handle* other) const;

protected:

private:


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

public:

  bool is_ancestor_of(const any* other) const;
  
  virtual tp* clone() const;

  bool invariant() const;


protected:
private:

};


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

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC std::ostream& operator<<(std::ostream& xos, tp_lite::table_dofs_type& xt);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

//==============================================================================
// TP FACET
//==============================================================================

namespace tp_algebra
{

SHEAF_DLL_SPEC void contract(const tp_lite& x0, int xp, int xq, tp_lite& xresult);

SHEAF_DLL_SPEC void contract(const tp& x0, int xp, int xq, tp& xresult,
                bool xauto_access);

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

SHEAF_DLL_SPEC void alt(const tp_lite& x0, tp_lite& xresult);

template <typename T0>
typename tensor_traits<T0::P, typename T0::vector_space_type>::atp_type*
alt(const T0& x0);

SHEAF_DLL_SPEC void alt(const tp& x0, tp& xresult, bool xauto_access);

SHEAF_DLL_SPEC void sym(const tp_lite& x0, tp_lite& xresult);

template <typename T0>
typename tensor_traits<T0::P, typename T0::vector_space_type>::stp_type*
sym(const T0& x0);

SHEAF_DLL_SPEC void sym(const tp& x0, tp& xresult, bool xauto_access);

template <typename T0>
typename tensor_traits<T0::P, typename T0::vector_space_type>::stp_type*
sym(const T0& x0, bool xauto_access);

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

SHEAF_DLL_SPEC void tensor(const tp_lite& x0, const tp_lite& x1, tp_lite& xresult);

SHEAF_DLL_SPEC void tensor(const tp& x0, const tp& x1, tp& xresult, bool xauto_access);

template <typename T0, typename T1>
typename tensor_traits<T0::P + T1::P, typename T0::vector_space_type>::tp_type*
tensor(const T0& x0, const T1& x1);

template <typename T0, typename T1>
typename tensor_traits<T0::P + T1::P, typename T0::vector_space_type>::tp_type*
tensor(const T0& x0, const T1& x1, bool xauto_access);


//==============================================================================
  
} // namespace tp_algebra

} // namespace fiber_bundle


#endif // ifndef TP_H