1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
|
/*
* Copyright (c) 2009 Samit Basu
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#include "Operators.hpp"
#include "Array.hpp"
#include <cmath>
struct OpCeil {
static inline float func(float t) { return ceilf(t); }
static inline double func(double t) {return ceil(t); }
static inline void func(float x, float y, float &rx, float &ry) {
rx = ceilf(x); ry = ceilf(y);
}
static inline void func(double x, double y, double &rx, double &ry) {
rx = ceil(x); ry = ceil(y);
}
};
//!
//@Module CEIL Ceiling Function
//@@Section ELEMENTARY
//@@Usage
//Computes the ceiling of an n-dimensional array elementwise. The
//ceiling of a number is defined as the smallest integer that is
//larger than or equal to that number. The general syntax for its use
//is
//@[
// y = ceil(x)
//@]
//where @|x| is a multidimensional array of numerical type. The @|ceil|
//function preserves the type of the argument. So integer arguments
//are not modified, and @|float| arrays return @|float| arrays as
//outputs, and similarly for @|double| arrays. The @|ceil| function
//is not defined for @|complex| or @|dcomplex| types.
//@@Example
//The following demonstrates the @|ceil| function applied to various
//(numerical) arguments. For integer arguments, the ceil function has
//no effect:
//@<
//ceil(3)
//ceil(-3)
//@>
//Next, we take the @|ceil| of a floating point value:
//@<
//ceil(float(3.023))
//ceil(float(-2.341))
//@>
//Note that the return type is a @|float| also. Finally, for a @|double|
//type:
//@<
//ceil(4.312)
//ceil(-5.32)
//@>
//@@Tests
//@$exact#y1=ceil(x1)
//@@Signature
//function ceil CeilFunction
//input x
//output y
//!
ArrayVector CeilFunction(int nargout, const ArrayVector& arg) {
if (arg.size() < 1)
throw Exception("ceil requires one argument");
return ArrayVector(UnaryOp<OpCeil>(arg[0]));
}
|