chart_point_2d.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/chart_point_2d.h"
#include "SheafSystem/assert_contract.h"

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


// ===========================================================
// CHART_POINT_2D FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

fiber_bundle::chart_point_2d::
chart_point_2d()
{
  // Preconditions:

  // Body:

  _chart_id = invalid_pod_index();

  // Postconditions:

  ensure(invariant());
  ensure(!is_valid());

  // Exit:

  return;
}

fiber_bundle::chart_point_2d::
chart_point_2d(const chart_point_2d& xother)
{
  // Preconditions:

  // Body:

  *this = xother;

  // Postconditions:

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

  // Exit:

  return;
}

fiber_bundle::chart_point_2d::
~chart_point_2d()
{
  // Preconditions:

  // Body:

  // Nothing to do.

  // Postconditions:

  // Exit:

  return;
}

fiber_bundle::chart_point_2d::
chart_point_2d(pod_index_type xchart_id, coord_type xu, coord_type xv)
{
  // Preconditions:

  // Body:

  _chart_id = xchart_id;
  _local_coords[0] = xu;
  _local_coords[1] = xv;

  // Postconditions:

  ensure(invariant());
  ensure(chart_id() == xchart_id);
  ensure(isunordered_or_equals(u(), xu));
  ensure(isunordered_or_equals(v(), xv));

  // Exit:

  return;
}

fiber_bundle::chart_point_2d::
chart_point_2d(const scoped_index& xchart_id, coord_type xu, coord_type xv)
{
  // Preconditions:

  // Body:

  _chart_id = xchart_id.hub_pod();
  _local_coords[0] = xu;
  _local_coords[1] = xv;

  // Postconditions:

  ensure(invariant());
  ensure(chart_id() == xchart_id.hub_pod());
  ensure(isunordered_or_equals(u(), xu));
  ensure(isunordered_or_equals(v(), xv));

  // Exit:

  return;
}

fiber_bundle::chart_point_2d::
chart_point_2d(pod_index_type xchart_id,
               const coord_type* xlocal_coords,
               size_type xlocal_coords_ub)
{
  // Preconditions:

  require(xlocal_coords != 0);
  require(xlocal_coords_ub >= db());

  // Body:

  _chart_id = xchart_id;
  put_local_coords(xlocal_coords, xlocal_coords_ub);

  // Postconditions:

  ensure(invariant());
  ensure(chart_id() == xchart_id);
  ensure_for_all(i, 0, db(), isunordered_or_equals(local_coord(i), xlocal_coords[i]));

  // Exit:

  return;
}

fiber_bundle::chart_point_2d::
chart_point_2d(const scoped_index& xchart_id,
               const coord_type* xlocal_coords,
               size_type xlocal_coords_ub)
{
  // Preconditions:

  require(xlocal_coords != 0);
  require(xlocal_coords_ub >= db());

  // Body:

  _chart_id = xchart_id.hub_pod();
  put_local_coords(xlocal_coords, xlocal_coords_ub);

  // Postconditions:

  ensure(invariant());
  ensure(chart_id() == xchart_id.hub_pod());
  ensure_for_all(i, 0, db(), isunordered_or_equals(local_coord(i), xlocal_coords[i]));

  // Exit:

  return;
}

int
fiber_bundle::chart_point_2d::
db() const
{
  int result;

  // Preconditions:


  // Body:

  result = 2;

  // Postconditions:

  ensure(result == 2);

  // Exit:

  return result;
}

fiber_bundle::chart_point_2d::coord_type
fiber_bundle::chart_point_2d::
local_coord(int xi) const
{
  coord_type result;

  // Preconditions:

  require((0 <= xi) && (xi < db()));

  // Body:

  result = _local_coords[xi];

  // Postconditions:


  // Exit:

  return result;
}

void
fiber_bundle::chart_point_2d::
put_local_coord(int xi, coord_type xvalue)
{
  // Preconditions:

  require((0 <= xi) && (xi < db()));

  // Body:

  _local_coords[xi] = xvalue;

  // Postconditions:


    ensure(isunordered_or_equals(local_coord(xi), xvalue));

  // Exit:

  return;
}

fiber_bundle::chart_point_2d::coord_type*
fiber_bundle::chart_point_2d::
local_coords()
{
  coord_type* result;

  // Preconditions:

  // Body:

  result = _local_coords;

  // Postconditions:

  ensure(result != 0);

  // Exit:

  return result;
}

const fiber_bundle::chart_point_2d::coord_type*
fiber_bundle::chart_point_2d::
local_coords() const
{
  const coord_type* result;

  // Preconditions:

  // Body:

  result = _local_coords;

  // Postconditions:

  ensure(result != 0);

  // Exit:

  return result;
}

const fiber_bundle::chart_point_2d::coord_type&
fiber_bundle::chart_point_2d::
u() const
{
  // Preconditions:

  // Body:

  const coord_type& result = _local_coords[0];

  // Postconditions:


  ensure(isunordered_or_equals(result, local_coord(0)));

  // Exit:

  return result;
}

const fiber_bundle::chart_point_2d::coord_type&
fiber_bundle::chart_point_2d::
v() const
{
  // Preconditions:

  // Body:

  const coord_type& result = _local_coords[1];

  // Postconditions:


  // The following seems reasonable,
  // but fails if result is NAN because NAN
  // doesn't == anything, not even itself.

    ensure(isunordered_or_equals(result, local_coord(1)));

  // Exit:

  return result;
}

void
fiber_bundle::chart_point_2d::
put(pod_index_type xchart_id, coord_type xu, coord_type xv)
{
  // Preconditions:

  // Body:

  _chart_id = xchart_id;
  _local_coords[0] = xu;
  _local_coords[1] = xv;

  // Postconditions:

  ensure(invariant());
  ensure(chart_id() == xchart_id);
  ensure(isunordered_or_equals(u(), xu));
  ensure(isunordered_or_equals(v(), xv));

  // Exit:

  return;
}

void
fiber_bundle::chart_point_2d::
put(const scoped_index& xchart_id, coord_type xu, coord_type xv)
{
  // Preconditions:

  // Body:

  put(xchart_id.hub_pod(), xu, xv);

  // Postconditions:

  ensure(invariant());
  ensure(chart_id() == xchart_id.hub_pod());
  ensure(isunordered_or_equals(u(), xu));
  ensure(isunordered_or_equals(v(), xv));

  // Exit:

  return;
}

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


// ===========================================================
// CHART_POINT FACET
// ===========================================================

// PUBLIC MEMBER FUNCTIONS

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


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

// PUBLIC MEMBER FUNCTIONS

fiber_bundle::chart_point_2d*
fiber_bundle::chart_point_2d::
clone() const
{
  chart_point_2d* result;

  // Preconditions:


  // Body:

  result = new chart_point_2d();

  // Postconditions:

  ensure(result->is_same_type(this));

  // Exit:

  return result;
}

bool
fiber_bundle::chart_point_2d::
invariant() const
{
  bool result = true;

  // Preconditions:

  // Body:

  if(invariant_check())
  {
    // Prevent recursive calls to invariant

    disable_invariant_check();

    invariance(chart_point::invariant());
    invariance(db() == 2);

    // Finished, turn invariant checking back on.

    enable_invariant_check();
  }

  // Postconditions:

  // Exit

  return result;
}

bool
fiber_bundle::chart_point_2d::
is_ancestor_of(const any* other) const
{

  // Preconditions:

  require(other != 0);

  // Body:

  // True if other conforms to this

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

  // Postconditions:

  // Exit:

  return result;
}

fiber_bundle::chart_point_2d&
fiber_bundle::chart_point_2d::
operator=(const chart_point_2d& xother)
{

  // Preconditions:
  
  // Body:

  _chart_id = xother._chart_id;
  _local_coords[0] = xother._local_coords[0];
  _local_coords[1] = xother._local_coords[1];

  // Postconditions:

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

  // Exit

  return *this;
}

// PROTECTED MEMBER FUNCTIONS

// PRIVATE MEMBER FUNCTIONS


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

size_t
fiber_bundle::
deep_size(const chart_point_2d& xvalue, bool xinclude_shallow)
{
  size_t result;
  
  // Preconditions:

  // Body:


  result = 0;
  
  // Postconditions:

  ensure(result == 0);
  //ensure(result >= 0);

  // Exit

  return result;
}