package_name.module module#

Module provides a simple cubic_rectification function.

package_name.module.cubic_rectification(x, verbose=False)[source]#

Rectified cube of an array.

Parameters:

  • x (numpy.ndarray) – Input array.

  • verbose (bool, optional) – Whether to print out details. Default is False.

Returns:

Elementwise, the cube of x where it is positive and 0 otherwise.

Return type:

numpy.ndarray

Note

This is a sample function, using a numpy docstring format.

Note

The use of intersphinx will cause numpy.ndarray to link to the numpy documentation page.