/*

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_idx_bounds_h)
#define octave_idx_bounds_h 1

#include <limits>

//The maximum value for octave_idx_type (and the maximum possible size of an
//Array)
const octave_idx_type idx_type_max_value =
    std::numeric_limits<octave_idx_type>::max ();

//The maximum index an array can have (idx_type_max_value - 1)
const octave_idx_type max_idx = idx_type_max_value - 1;

//Determines if a row-col pair will overflow octave_idx_type if translated into
//a linear index
inline bool
row_col_to_idx_overflows (octave_idx_type row, octave_idx_type col,
                          octave_idx_type height)
{
  return row > (max_idx - col) / height;
}

//Determines if a height-width pair will overflow octave_idx_type when nelem is
//extracted
inline bool
height_width_to_nelem_overflows (octave_idx_type height, octave_idx_type width)
{
  return width > idx_type_max_value / height;
}

#endif