jcb.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 JCB_H
#define JCB_H

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

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

#ifndef JCB_TABLE_DOFS_TYPE_H
#include "SheafSystem/jcb_table_dofs_type.h"
#endif
 

namespace fiber_bundle
{
  //
  // Forward declarations
  //

  class at1;
  class jcb_space;

//==============================================================================
// CLASS JCB_LITE
//==============================================================================

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

public:

  typedef jcb_table_dofs_type table_dofs_type;

  jcb_lite();

  jcb_lite(const jcb_lite& xother);

  jcb_lite& operator=(const jcb_lite& xother);

  virtual ~jcb_lite();

  jcb_lite(const row_dofs_type& xrow_dofs);

  jcb_lite& operator=(const row_dofs_type& xrow_dofs);

  virtual int dd() const;

  virtual int dr() const;

  table_dofs_type table_dofs() const;

  using vd_lite::component;
  using vd_lite::put_component;  

  value_type component(int xrow, int xcolumn) const;

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

  virtual int index_for_row_column(int xrow, int xcolumn) 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 jcb_lite* clone() const;

protected:
private:



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

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;

  bool invariant() const;

protected:
private:

};


//==============================================================================
// CLASS JCB
//==============================================================================

class SHEAF_DLL_SPEC jcb : public vd
{

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

public:

  typedef jcb_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& xdomain_path,
                 const poset_path& xrange_path,
                 bool xauto_access);

protected:

private:

 

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

public:

  // Typedefs:

  typedef at1 domain_type;

//   ///
//   /// The type of vector space; synonym for domain_type.
//   /// @hack Just to make jcb consistent with namespace 
//   /// factory queries designed for tensor spaces.
//   ///
//   typedef domain_type vector_space_type;

  typedef at1 range_type;

  typedef jcb_lite volatile_type;

  typedef jcb_table_dofs_type table_dofs_type;

  jcb();

  jcb(const poset_state_handle* xhost, pod_index_type xhub_id);

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

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

  explicit jcb(abstract_poset_member* xother);

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

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

  jcb& operator=(const jcb& xother);

  ~jcb();

  virtual const volatile_type& lite_prototype() const;

  virtual volatile_type* lite_type() const;

  virtual int dd() const;

  int dd(bool xauto_access) const;

  poset_path domain_path() const;

  poset_path domain_path(bool xauto_access) const;

  virtual int dr() const;

  int dr(bool xauto_access) const;

  poset_path range_path() const;

  poset_path range_path(bool xauto_access) const;

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

protected:
private:



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

public:

  using vd::component;
  using vd::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);

protected:
private:



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

public:

protected:

private:



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

public:

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

  static const std::string& static_class_name();

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

  virtual jcb* clone() const; // = 0;

  bool invariant() const;

protected:
private:

};

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

#ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

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

#endif // ifndef DOXYGEN_1_5_4_SKIP_UNKNOWN

class at1;
class at1_lite;

//==============================================================================
// JCB FACET:
//==============================================================================

namespace jcb_algebra
{

#ifndef DOXYGEN_SKIP_UNKNOWN

SHEAF_DLL_SPEC void push(const jcb& xjcb,
             const at1& xvector,
             at1& xresult,
             bool xauto_access);

SHEAF_DLL_SPEC void push(const jcb_lite& xjcb,
             const at1_lite& xvector,
             at1_lite& xresult);

SHEAF_DLL_SPEC at1_lite* push(const jcb_lite& xjcb, const at1_lite& xvector);

#endif // ifndef DOXYGEN_SKIP_UNKNOWN

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

SHEAF_DLL_SPEC void pull(const jcb& xjcb,
             const at1& xcovector,
             at1& xresult,
             bool xauto_access);

SHEAF_DLL_SPEC void pull(const jcb_lite& xjcb,
             const at1_lite& xcovector,
             at1_lite& xresult);

SHEAF_DLL_SPEC at1_lite* pull(const jcb_lite& xjcb, const at1_lite& xvector);
  
} // namespace jcb_algebra

} // namespace fiber_bundle


#endif // ifndef JCB_H