ijk_product_structure.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 IJK_PRODUCT_STRUCTURE_H
#define IJK_PRODUCT_STRUCTURE_H

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

#ifndef ABSTRACT_PRODUCT_STRUCTURE_H
#include "SheafSystem/abstract_product_structure.h"
#endif

#ifndef POD_TYPES_H
#include "SheafSystem/pod_types.h"
#endif

namespace sheaf
{
  
class SHEAF_DLL_SPEC ijk_product_structure : public abstract_product_structure
{

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

public:

  ijk_product_structure(size_type xi_ub, size_type xj_ub, size_type xk_ub);

  ijk_product_structure(const ijk_product_structure& xother);

  ijk_product_structure& operator=(const ijk_product_structure& xother);

  virtual ~ijk_product_structure();

protected:

  ijk_product_structure() { };

  size_type _i_ub;

  size_type _j_ub;

  size_type _k_ub;

private:



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

public:

  virtual ijk_product_structure* clone() const;

  virtual ijk_product_structure& operator=(const abstract_product_structure& xother);

  virtual bool operator==(const abstract_product_structure& xother) const;

protected:

private:



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

public:

  virtual size_type d() const;

  virtual size_type ub(pod_type xi) const;

  size_type i_ub() const;

  size_type j_ub() const;

  size_type k_ub() const;

  void ordinal(pod_type xi, pod_type xj, pod_type xk, pod_type& xordinal) const;

  virtual void ordinal(pod_type* xtuple, pod_type& xordinal) const;

  void tuple(pod_type xordinal, pod_type& xi, pod_type& xj, pod_type& xk) const;

  virtual void tuple(pod_type xordinal, pod_type* xtuple) const;

  void put_ubs(size_type xi_ub, size_type xj_ub, size_type xk_ub);

  virtual void put_ubs(size_type* xubs);

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual bool invariant() const;

protected:

private:


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
inline pod_index_type ordinal(pod_index_type x0, 
                  pod_index_type x1, 
                  pod_index_type x2, 
                  pod_index_type x1_end,
                  pod_index_type x2_end)
{
  return (x0*x1_end+x1)*x2_end + x2;
};
  
inline void tuple(pod_index_type x, 
          pod_index_type x1_end, 
          pod_index_type x2_end, 
          pod_index_type& x0, 
          pod_index_type& x1, 
          pod_index_type& x2)
{
  // x == (x0*x1_end + x1)*x2_end + x2;

  x2 = x % x2_end;

  x /= x2_end; 

  // now x = x0*x1_end + x1.

  x1 = x % x1_end;
  x0 = x / x1_end;
};
 
SHEAF_DLL_SPEC 
size_t deep_size(const ijk_product_structure& xn, bool xinclude_shallow = true);
  
} // end namespace sheaf

#endif // ifndef IJK_PRODUCT_STRUCTURE_H