scummvm/common/cosinetables.h
David Fioramonti 9cfc70e7fe COMMON: allow cos/sin number of points to be more flexible
Previously, the cos/sin table had to be a power of 2, but there
are many use cases where the number of points is not necessarily
a power of 2 so this change the constructor so it now takes
in the number of points rather than the number of points as the
exponent of a power of 2.

The restriction is that the size must be divisible by 4.
2018-08-18 16:30:57 +02:00

67 lines
2.0 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef COMMON_COSINETABLES_H
#define COMMON_COSINETABLES_H
namespace Common {
class CosineTable {
public:
/**
* Construct a cosine table given the number of points
*
* @param nPoints Number of distinct radian points, which must be in range [16,65536] and be divisible by 4
*/
CosineTable(int nPoints);
~CosineTable();
/**
* Get pointer to table.
*
* This table contains nPoints/2 entries.
* Prefer to use at()
* The layout of this table is as follows:
* - Entries 0 up to (including) nPoints/4:
* cos(0) till (including) cos(1/2*pi)
* - Entries (excluding) nPoints/4 up to nPoints/2:
* (excluding) cos(3/2*pi) till (excluding) cos(2*pi)
*/
const float *getTable() { return _table; }
/**
* Returns cos(2*pi * index / nPoints )
* Index must be in range [0, nPoints - 1]
*/
float at(int index) const;
private:
float *_table;
double _radResolution; // Smallest radian increment
int _refSize; // _nPoints / 4
int _nPoints; // range of operator[]
};
} // End of namespace Common
#endif // COMMON_COSINETABLES_H