nlcpy.cos

nlcpy.cos = <ufunc 'nlcpy_cos'>

Computes the element-wise cosine.

Parameters

xarray_like

Input an array or a scalar in radians.

outndarray or None, optional

A location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or None, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs.

wherearray_like, optional

This condition is broadcast over the input. At locations where the condition is True, the out array will be set to the ufunc result. Elsewhere, the out array will retain its original value. Note that if an uninitialized out array is created via the default out=None, locations within it where the condition is False will remain uninitialized.

**kwargs

For other keyword-only arguments, see the section Optional Keyword Arguments.

Returns

yndarray

The cosine values for each element of x. If x is a scalar, this function returns the result as a 0-dimension ndarray.

See also

arccos

Computes the element-wise inverse cosine.

cosh

Computes the element-wise hyperbolic cosine.

sin

Computes the element-wise sine.

Examples

>>> import nlcpy as vp
>>> vp.cos(vp.array([0, vp.pi/2, vp.pi]))   
array([ 1.000000e+00,  6.123234e-17, -1.000000e+00])
>>>
>>> # Example of providing the optional output parameter
>>> out1 = vp.array([0], dtype='d')
>>> out2 = vp.cos([0.1], out=out1)
>>> out2 is out1
True