stp.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 STP_H
#define STP_H

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

#ifndef TP_H
#include "SheafSystem/tp.h"
#endif

namespace fiber_bundle
{
  class stp_space;
  
//==============================================================================
// CLASS STP_LITE
//==============================================================================

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

public:

  stp_lite();

  stp_lite(const stp_lite& xother);

  stp_lite& operator=(const stp_lite& xother);

  virtual ~stp_lite();

  stp_lite(const row_dofs_type& xrow_dofs);

  stp_lite& operator=(const row_dofs_type& xrow_dofs);

protected:
private:



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

public:
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 stp_lite* clone() const;

protected:
private:



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

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;

  bool invariant() const;

protected:
private:

};

//==============================================================================
// CLASS STP
//==============================================================================


class SHEAF_DLL_SPEC stp : public tp
{
  // ===========================================================
  // ===========================================================

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

protected:

private:



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

public:

  typedef stp_lite volatile_type;

  stp();

  stp(const poset_state_handle* xhost, pod_index_type xhub_id);

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

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

  explicit stp(abstract_poset_member* xother);

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

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

  stp& operator=(const stp& xother);

  ~stp();

  virtual const volatile_type& lite_prototype() const;

  virtual volatile_type* lite_type() const;

protected:
private:




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

public:
  
protected:

private:



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

public:
protected:
private:


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

public:

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

  static const std::string& static_class_name();

  inline stp* clone(bool xnew_state, bool xauto_access = true) const
  {
    return static_cast<stp*>(tp::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* xother) const;
  
  virtual stp* clone() const;

  bool invariant() const;

protected:
private:

};

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

//$$SCRIBBLE: Currently all symmetric_product functions are
//            "not_implemented()" because the only meaningful
//            results would be like Sym(st2 (X) st2) = st4.
//            But we have not yet implemented any st4 classes.

namespace stp_algebra
{

SHEAF_DLL_SPEC void symmetric_product(const stp_lite& x0, const stp_lite& x1,
                      stp_lite& xresult);

SHEAF_DLL_SPEC void symmetric_product(const stp& x0, const stp& x1, stp& xresult,
                      bool xauto_access);

template <typename T0, typename T1>
typename tensor_traits<T0::P + T1::P, typename T0::vector_space_type>::tp_type*
symmetric_product(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*
symmetric_product(const T0& x0, const T1& x1, bool xauto_access);

} // namespace stp_algebra

} // namespace fiber_bundle

#endif // ifndef STP_H