API Documentation

This contains automatically generated API documentation for the example function in this repository. You can add more information to this markdown file as needed.

Squares the input value.

This function computes the square of a given number or NumPy array.

Parameters

x : int, float, or npt.NDArray The input value(s) to be squared.

Returns

result : int, float, or npt.NDArray The squared result of x.

Raises

TypeError If x is not an int, float, or NumPy array.

Notes

This function uses np.square(x), which is optimized for NumPy arrays.

Examples

Square an integer:

example_function(3) 9

Square a float:

example_function(2.5) 6.25

Square a NumPy array:

import numpy as np arr = np.array([1, 2, 3]) example_function(arr) array([1, 4, 9])

References

.. [1] NumPy Documentation: https://numpy.org/doc/stable/reference/generated/numpy.square.html