/* SampledXY_def.h
 *
 * Copyright (C) 1992-2011,2013,2014 Paul Boersma
 *
 * This program 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 2 of the License, or (at
 * your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 * pb 20131022 split off from Matrix
 */

#define ooSTRUCT SampledXY
oo_DEFINE_CLASS (SampledXY, Sampled)

	oo_DOUBLE (ymin)
	oo_DOUBLE (ymax)
	oo_LONG (ny)
	oo_DOUBLE (dy)
	oo_DOUBLE (y1)

	#if oo_DECLARING
		// overridden methods:
			//virtual void v_info ();
			virtual bool v_hasGetYmin      () { return true; }   virtual double v_getYmin      ()        { return ymin; }
			virtual bool v_hasGetYmax      () { return true; }   virtual double v_getYmax      ()        { return ymax; }
			virtual bool v_hasGetNy        () { return true; }   virtual double v_getNy        ()        { return ny; }
			virtual bool v_hasGetDy        () { return true; }   virtual double v_getDy        ()        { return dy; }
			virtual bool v_hasGetY         () { return true; }   virtual double v_getY         (long iy) { return y1 + (iy - 1) * dy; }
		// functions:
			void f_init (double xmin, double xmax, long nx, double dx, double x1,
			             double ymin, double ymax, long ny, double dy, double y1);
			double f_indexToY (double index) { return y1 + (index - 1.0) * dy; }
			double f_yToIndex (double y) { return (y - y1) / dy + 1.0; }
			long f_yToLowIndex     (double y) { return (long) floor (f_yToIndex (y)); }
			long f_yToHighIndex    (double y) { return (long) ceil  (f_yToIndex (y)); }
			long f_yToNearestIndex (double y) { return (long) round (f_yToIndex (y)); }
			long f_getWindowSamplesY (double ymin, double ymax, long *iymin, long *iymax);
	#endif

oo_END_CLASS (SampledXY)
#undef ooSTRUCT


/* End of file SampledXY_def.h */
