/*

Copyright (C) 2014 David Spies

This file is part of Octave.

Octave is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

Octave is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with Octave; see the file COPYING.  If not, see
<http://www.gnu.org/licenses/>.

*/
#if !defined (octave_interp_idx_h)
#define octave_interp_idx_h 1

#include "idx-bounds.h"
#include "Array-util.h"

// Simple method for converting between C++ octave_idx_type and
// Octave data-types (convert to double and add one).
inline double
to_interp_idx (octave_idx_type idx)
{
  return idx + 1.L;
}

// Simple method for taking a row-column pair together with the matrix
// dimensions and returning the corresponding index as an octave data-type
// (note that for large heights, there's a risk of losing precision.
// This method will not overflow or throw a bad alloc, it will simply
// choose the nearest possible double-value to the proper index).
inline double
to_interp_idx (octave_idx_type row, octave_idx_type col, const dim_vector& dims)
{
#if defined(BOUNDS_CHECKING)
  check_index (row, col, dims);
#endif
  return col * static_cast<double> (dims(0)) + row + 1;
}

//Converts a row-column pair to a "flat" linear index.
//Asserts that its result won't overflow octave_idx_type
inline octave_idx_type
to_flat_idx (octave_idx_type row, octave_idx_type col, const dim_vector& dims)
{
  assert(!row_col_to_idx_overflows (row, col, dims(0)));
  return compute_index (row, col, dims, false);
}

#endif