i_adjacency_index_space_interval.cc

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.
//


#include "SheafSystem/i_adjacency_index_space_interval.h"

#include "SheafSystem/abstract_product_structure.h"
#include "SheafSystem/assert_contract.h"
#include "SheafSystem/i_adjacency_implicit_index_space_iterator.h"
#include "SheafSystem/forwarding_index_space_handle.h"
#include "SheafSystem/explicit_index_space_state.h"
#include "SheafSystem/hub_index_space_handle.h"
#include "SheafSystem/index_space_family.h"

using namespace std;
using namespace fiber_bundle; // Workaround for MS C++ bug.

// ===========================================================
// SPACE FACTORY FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

const fiber_bundle::i_adjacency_index_space_interval&
fiber_bundle::i_adjacency_index_space_interval::
new_space(index_space_family& xid_spaces,
      size_type xub,
      pod_type xzone_hub_begin,
      size_type xi_size)
{
  // Preconditions:

  require(xub > 0);
  require(xid_spaces.hub_id_space().contains(xzone_hub_begin));
  require(xi_size > 0);

  // Body:

  define_old_variable(size_type old_id_spaces_end = xid_spaces.end());

  i_adjacency_index_space_interval* result_ptr = new i_adjacency_index_space_interval();
  result_ptr->new_state(xid_spaces, xub);

  result_ptr->_zone_hub_begin = xzone_hub_begin;
  result_ptr->_i_size = xi_size;

  const i_adjacency_index_space_interval& result = *result_ptr;

  // Postconditions:

  ensure(&result.id_spaces() == &xid_spaces);
  ensure(result.begin() == old_id_spaces_end);
  ensure(result.end() == xid_spaces.end());
  ensure(result.end() == result.begin() + xub);

  ensure(result.zone_hub_begin() == xzone_hub_begin);
  ensure(result.i_size() == xi_size);

  // Exit:

  return result;
}

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
// I_ADJACENCY_INDEX_SPACE_INTERVAL FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

fiber_bundle::i_adjacency_index_space_interval::
~i_adjacency_index_space_interval()
{  
  // Preconditions:
    
  // Body:

  // Nothing to do.
  
  // Postconditions:

  // Exit:

  return; 
}

fiber_bundle::i_adjacency_index_space_interval::pod_type
fiber_bundle::i_adjacency_index_space_interval::
zone_hub_begin() const
{
  // Preconditions:

  // Body:

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return _zone_hub_begin;
}

fiber_bundle::i_adjacency_index_space_interval::pod_type
fiber_bundle::i_adjacency_index_space_interval::
zone_hub_begin(pod_type xlocal_id) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  pod_type result = xlocal_id + _zone_hub_begin;

  if(xlocal_id > 0)
  {
    result -= 1;
  }
  
  // Postconditions:

  ensure(result >= zone_hub_begin());

  // Exit:

  return result;
}

void
fiber_bundle::i_adjacency_index_space_interval::
adjacent_zones(pod_type xlocal_id,
           pod_type& xzone_hub_begin,
           size_type& xi_ct) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  // Calculate the first adjacent zone id and the number of adjacent
  // zones in the i and j directions.

  xi_ct = 0;
  xzone_hub_begin = xlocal_id + _zone_hub_begin;

  if(xlocal_id > 0)
  {
    xi_ct++;
    xzone_hub_begin -= 1;
  }
  
  if(xlocal_id < _i_size)
  {
    xi_ct++;
  }

  // Postconditions:

  ensure(xzone_hub_begin >= zone_hub_begin());
  ensure((0 < xi_ct) && (xi_ct <= 2));

  // Exit:

  return;
}

sheaf::size_type
fiber_bundle::i_adjacency_index_space_interval::
i_size() const
{
  // Preconditions:

  // Body:

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return _i_size;
}

// PROTECTED MEMBER FUNCTIONS

fiber_bundle::i_adjacency_index_space_interval::
i_adjacency_index_space_interval()
  : index_space_interval()
{
  // Preconditions:
    
  // Body:

  // Postconditions:

  ensure(invariant());

  // Exit:

  return; 
}

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
// INDEX_SPACE_INTERVAL FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
// FACTORY FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

const std::string&
fiber_bundle::i_adjacency_index_space_interval::
class_name() const
{
  static const string result("i_adjacency_index_space_interval");
  return result;
}

fiber_bundle::i_adjacency_index_space_interval*
fiber_bundle::i_adjacency_index_space_interval::
clone() const
{
  // Preconditions:

  // Body:

  i_adjacency_index_space_interval* result =
    new i_adjacency_index_space_interval();

  // Postconditions:

  ensure(result != 0);
  ensure(is_same_type(result));

  // Exit:

  return result;
}

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS

bool
fiber_bundle::i_adjacency_index_space_interval::
make_prototype()
{
  // Preconditions:

  // Body:

  i_adjacency_index_space_interval* lproto = new i_adjacency_index_space_interval();

  id_space_interval_factory().insert_prototype(lproto);

  // Postconditions:

  // Exit:

  return true;
}


// ===========================================================
// INDEX_SPACE_COLLECTION FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

bool
fiber_bundle::i_adjacency_index_space_interval::
operator==(const index_space_collection& xother) const
{
  // Preconditions:

  require(is_ancestor_of(&xother));

  // Body:

  const i_adjacency_index_space_interval& lother =
    dynamic_cast<const i_adjacency_index_space_interval&>(xother);

  bool result = index_space_interval::operator==(xother);

  result = result && (_zone_hub_begin == lother._zone_hub_begin);
  result = result && (_i_size == lother._i_size);

  // Postconditions:

  // Exit

  return result;
}

sheaf::size_type
fiber_bundle::i_adjacency_index_space_interval::
deep_size(bool xinclude_shallow) const
{
  // Preconditions:

  // Body:

  size_type result = fiber_bundle::deep_size(*this, xinclude_shallow);

  // Postconditions:

  ensure(result >= 0);

  // Exit:

  return result;
}

// PROTECTED MEMBER FUNCTIONS

fiber_bundle::i_adjacency_index_space_interval&
fiber_bundle::i_adjacency_index_space_interval::
operator=(const index_space_collection& xother)
{
  // Preconditions:

  require(is_ancestor_of(&xother));

  // Body:

  const i_adjacency_index_space_interval& lother =
    dynamic_cast<const i_adjacency_index_space_interval&>(xother);

  _zone_hub_begin = lother._zone_hub_begin;
  _i_size = lother._i_size;

  index_space_interval::operator=(xother);

  // Postconditions:

  ensure(invariant());
  ensure((*this) == xother);

  // Exit:

  return *this;
}

sheaf::explicit_index_space_state*
fiber_bundle::i_adjacency_index_space_interval::
explicit_state(pod_type xlocal_id) const
{
  // Preconditions:

  // Body:


  explicit_index_space_state* result = 0;

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
// INDEX SPACE FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

void
fiber_bundle::i_adjacency_index_space_interval::
remove(pod_type xlocal_id)
{
  // Preconditions:

  // Body:


  not_implemented();
  
  // Postconditions:

  ensure(!contains(xlocal_id));

  // Exit:

  return;
}

sheaf::size_type
fiber_bundle::i_adjacency_index_space_interval::
ct(pod_type xlocal_id) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  // Determine if this vertex is adjacent to 1 or 2 zones.

  pod_type result = (xlocal_id > 0 && xlocal_id < _i_size) ? 2 : 1;

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

sheaf::index_space_collection::pod_type
fiber_bundle::i_adjacency_index_space_interval::
begin(pod_type xlocal_id) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  pod_type result = 0;

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

sheaf::index_space_collection::pod_type
fiber_bundle::i_adjacency_index_space_interval::
end(pod_type xlocal_id) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  pod_type result = ct(xlocal_id);

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

bool
fiber_bundle::i_adjacency_index_space_interval::
contains(pod_type xlocal_id, pod_type xid) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  bool result = (0 <= xid) && (xid < end(xlocal_id));

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

bool
fiber_bundle::i_adjacency_index_space_interval::
contains_unglued_hub(pod_type xlocal_id, pod_type xid) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  // Compute the adjacent values.

  pod_type lzone_hub_begin;
  size_type li_ct;

  adjacent_zones(xlocal_id, lzone_hub_begin, li_ct);

  // Calculate the zone id relative to the first adjacent zone
  // adjacent to vertex xlocal_id.

  pod_type i = (xid - lzone_hub_begin);

  bool result = ((0 <= i) && (i < li_ct));

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

bool
fiber_bundle::i_adjacency_index_space_interval::
contains(pod_type xlocal_id, pod_type xid, pod_type xhub_id) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  bool result = is_valid(xhub_id) && (hub_pod(xlocal_id, xid) == xhub_id);

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

sheaf::index_space_collection::pod_type
fiber_bundle::i_adjacency_index_space_interval::
pod(pod_type xlocal_id, pod_type xid) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  // Compute the adjacent values.

  pod_type lzone_hub_begin;
  size_type li_ct;

  adjacent_zones(xlocal_id, lzone_hub_begin, li_ct);

  // Calculate the zone id relative to the first adjacent zone
  // adjacent to vertex xlocal_id.

  pod_type i = (xid - lzone_hub_begin);

  // Compute pod.

  pod_type result = ((0 <= i) && (i < li_ct)) ? i : invalid_pod_index();

  // Postconditions:

  ensure(!is_valid(result) || contains(xlocal_id, result));

  // Exit:

  return result;
}

sheaf::index_space_collection::pod_type
fiber_bundle::i_adjacency_index_space_interval::
unglued_hub_pod(pod_type xlocal_id, pod_type xid) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  // Compute the adjacent values.

  pod_type lzone_hub_begin;
  size_type li_ct;

  adjacent_zones(xlocal_id, lzone_hub_begin, li_ct);

  // Compute the hub pod.

  pod_type result =
    ((0 <= xid) && (xid < li_ct)) ? lzone_hub_begin + xid : invalid_pod_index();

  // Postconditions:

  ensure(!is_valid(result) || contains_unglued_hub(xlocal_id, result));

  // Exit:

  return result;
}

bool
fiber_bundle::i_adjacency_index_space_interval::
is_persistent(pod_type xlocal_id) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  bool result = false;

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
// PRODUCT STRUCTURE FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

void
fiber_bundle::i_adjacency_index_space_interval::
new_product_structure(pod_type xlocal_id,
              const abstract_product_structure& xproduct)
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:


  not_implemented();

  // Postconditions:

  ensure(has_product_structure(xlocal_id));

  // Exit:

  return;
}

void
fiber_bundle::i_adjacency_index_space_interval::
delete_product_structure(pod_type xlocal_id)
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:


  not_implemented();
  
  // Postconditions:

  ensure(!has_product_structure(xlocal_id));

  // Exit:

  return;
}

const sheaf::abstract_product_structure&
fiber_bundle::i_adjacency_index_space_interval::
product_structure(pod_type xlocal_id) const
{
  // Preconditions:

  require(contains(xlocal_id));
  require(has_product_structure(xlocal_id));

  // Body:


  const abstract_product_structure* result = 0; // Just to silence compiler warnings.

  not_implemented();

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return *result;
}

sheaf::abstract_product_structure&
fiber_bundle::i_adjacency_index_space_interval::
product_structure(pod_type xlocal_id)
{
  // Preconditions:

  require(contains(xlocal_id));
  require(has_product_structure(xlocal_id));

  // Body:


  abstract_product_structure* result = 0; // Just to silence compiler warnings.

  not_implemented();
  
  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return *result;
}

bool
fiber_bundle::i_adjacency_index_space_interval::
has_product_structure(pod_type xlocal_id) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:


  bool result = false; // Just to silence compiler warnings.

  not_implemented();
  
  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
// HANDLE POOL FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

sheaf::index_space_handle&
fiber_bundle::i_adjacency_index_space_interval::
get_id_space(pod_type xlocal_id) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  index_space_handle& result = _handles.get();
  result.attach_to(*this, xlocal_id);

  // Postconditions:

  ensure(result.is_attached());

  // Exit:

  return result;
}

void
fiber_bundle::i_adjacency_index_space_interval::
release_id_space(index_space_handle& xid_space) const
{
  // Preconditions:

  require(allocated_id_space(xid_space));

  // Body:

  // Detach the handle.

  xid_space.detach();

  // Release the handle to the pool.

  _handles.release(reinterpret_cast<forwarding_index_space_handle&>(xid_space));

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return;
}

bool
fiber_bundle::i_adjacency_index_space_interval::
allocated_id_space(const index_space_handle& xid_space) const
{
  // Preconditions:

  // Body:

  const forwarding_index_space_handle* lid_space =
    dynamic_cast<const forwarding_index_space_handle*>(&xid_space);

  bool result = (lid_space != 0) && _handles.allocated(*lid_space);

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
// ITERATOR POOL FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

sheaf::index_space_iterator&
fiber_bundle::i_adjacency_index_space_interval::
get_id_space_iterator(pod_type xlocal_id) const
{
  // Preconditions:

  require(contains(xlocal_id));

  // Body:

  index_space_iterator& result = _iterators.get();
  result.attach_to(*this, xlocal_id);

  // Postconditions:

  ensure(result.is_attached());

  // Exit:

  return result;
}

void
fiber_bundle::i_adjacency_index_space_interval::
release_id_space_iterator(index_space_iterator& xitr) const
{
  // Preconditions:

  require(allocated_id_space_iterator(xitr));

  // Body:

  // Detach the iterator.

  xitr.detach();

  // Release the iterator to the pool.

  _iterators.release(reinterpret_cast<i_adjacency_implicit_index_space_iterator&>(xitr));

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return;
}

bool
fiber_bundle::i_adjacency_index_space_interval::
allocated_id_space_iterator(const index_space_iterator& xitr) const
{
  // Preconditions:

  // Body:

  const i_adjacency_implicit_index_space_iterator* litr =
    dynamic_cast<const i_adjacency_implicit_index_space_iterator*>(&xitr);

  bool result = (litr != 0) && _iterators.allocated(*litr);

  // Postconditions:

  ensure(is_basic_query);

  // Exit:

  return result;
}

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
// ANY FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

bool
fiber_bundle::i_adjacency_index_space_interval::
is_ancestor_of(const any *other) const
{
  // Preconditions:

  require(other != 0);

  // Body:

  // True if other conforms to this

  bool result = dynamic_cast<const i_adjacency_index_space_interval*>(other) != 0;

  // Postconditions:

  // Exit:

  return result;
}

bool
fiber_bundle::i_adjacency_index_space_interval::
invariant() const
{
  bool result = true;
  
  if(invariant_check())
  {
    // Prevent recursive calls to invariant

    disable_invariant_check();

    // Must satisfy base class invariant

    invariance(index_space_interval::invariant());

    // Invariances for this class:
      
    // Finished, turn invariant checking back on.      

    enable_invariant_check();
  }
  
  // Exit

  return result;
}

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
//  NON-MEMBER FUNCTIONS
// ===========================================================
 
size_t
fiber_bundle::
deep_size(const i_adjacency_index_space_interval& xn, bool xinclude_shallow)
{
  // Preconditions:

  // Body:

  size_t result = xinclude_shallow ? sizeof(xn) : 0;

  // Add contributions for _handles.

  result += deep_size(xn._handles, false);
  
  // Add contributions for _iterators.

  result += deep_size(xn._iterators, false);
  
  // Postconditions:

  ensure(result >= 0);

  // Exit

  return result;
}