st2.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 ST2_H
#define ST2_H

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

#ifndef STP_H
#include "SheafSystem/stp.h"
#endif

namespace fiber_bundle
{

//==============================================================================
// CLASS ST2_LITE
//==============================================================================

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

public:

  typedef vd_value_type value_type;

  st2_lite();

  st2_lite(const st2_lite& xother);

  st2_lite& operator=(const st2_lite& xother);

  virtual ~st2_lite();

  st2_lite(const row_dofs_type& xrow_dofs);

  st2_lite& operator=(const row_dofs_type& xrow_dofs);

  using stp_lite::component;
  using stp_lite::put_component;

  virtual value_type component(int xrow, int xcolumn) const;

  virtual void put_component(int xrow, int xcolumn, value_type xcomp);

  virtual int index_for_row_column(int xrow, int xcolumn) const;

protected:
private:



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

public:
protected:
private:



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

public:

  enum static_const_int {P = 2};  
  
  virtual int p() const;

protected:
private:



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

public:
protected:
private:



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

public:
protected:
private:



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

public:

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

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

protected:
private:



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

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;

  bool invariant() const;


protected:
private:

};

//==============================================================================
// CLASS ST2
//==============================================================================

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

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

protected:

private:



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

public:

  typedef st2_lite volatile_type;

  st2();

  st2(const poset_state_handle* xhost, pod_index_type xhub_id);

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

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

  explicit st2(abstract_poset_member* xother);

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

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

  st2& operator=(const st2& xother);

  ~st2();

  virtual const volatile_type& lite_prototype() const;

  virtual volatile_type* lite_type() const;


  using stp::component;
  using stp::put_component;

  value_type component(int xrow, int xcolumn) const;

  value_type component(int xrow, int xcolumn, bool xauto_access) const;

  void put_component(int xrow, int xcolumn, value_type xvalue);

  void put_component(int xrow, int xcolumn, value_type xvalue,
                     bool xauto_access);

  virtual int index_for_row_column(int xrow, int xcolumn) const;


protected:
private:



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

public:
protected:
private:



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

public:

  enum static_const_int {P = 2};  
  
protected:
private:



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

public:
protected:
private:



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

public:

protected:

private:



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

public:

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

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

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

protected:
private:



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

public:


  bool is_ancestor_of(const any* xother) const;

  bool invariant() const;


protected:
private:

};

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

//==============================================================================
// ST2 FACET
//==============================================================================

namespace st2_algebra
{

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

SHEAF_DLL_SPEC void trace(const st2& x0, vd_value_type& xresult, bool xauto_access);

SHEAF_DLL_SPEC vd_value_type trace(const st2& x0, bool xauto_access);

SHEAF_DLL_SPEC void trace(const st2_lite& x0, vd_value_type& xresult);

SHEAF_DLL_SPEC vd_value_type trace(const st2_lite& x0);

SHEAF_DLL_SPEC void determinant(const st2& x0, vd_value_type& xresult, bool xauto_access);

SHEAF_DLL_SPEC vd_value_type determinant(const st2& x0, bool xauto_access);

SHEAF_DLL_SPEC void determinant(const st2_lite& x0, vd_value_type& xresult);

SHEAF_DLL_SPEC vd_value_type determinant(const st2_lite& x0);

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

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

template <typename T, typename GLN>
T* to_principal_axes(const T& xlite, GLN& xtransform);

template <typename T, typename GLN>
void to_principal_axes(const T& xlite, GLN& xtransform, T& xresult);

template <typename T, typename GLN>
void
to_principal_axes(const T& xlite, const T& xpd_lite,
                  GLN& xtransform, T& xresult);

} // namespace st2_algebra

} // namespace fiber_bundle

#endif // ifndef ST2_H