NumPy: numpy.fromfunction() function

Last update on March 21 2023 12:07:11 (UTC/GMT +8 hours)

numpy.fromfunction() function

The numpy.fromfunction() function is used to construct an array by executing a function over each coordinate. The resulting array therefore has a value fn(x, y, z) at coordinate (x, y, z).

The fromfunction() function can be used to create arrays with complex values, as well as to create arrays with values that depend on the index. It is often used to create arrays with a specific mathematical pattern or formula.

Syntax:

numpy.fromfunction(function, shape, **kwargs)

Parameters:

Name	Description	Required / Optional
function	The function is called with N parameters, where N is the rank of shape. Each parameter represents the coordinates of the array varying along a specific axis. For example, if shape were (2, 2), then the parameters would be array([[0, 0], [1, 1]]) and array([[0, 1], [0, 1]])	Required
shape	Shape of the output array, which also determines the shape of the coordinate arrays passed to function.	Required
dtype	Data-type of the coordinate arrays passed to function. By default, dtype is float.	Optional

Return value:

fromfunction : any
The result of the call to function is passed back directly. Therefore the shape of fromfunction is completely determined by function. If function returns a scalar value, the shape of fromfunction would match the shape parameter.

Example: Using numpy.fromfunction() to create a boolean array

>>> import numpy as np
>>> np.fromfunction(lambda i, j: i == j, (2, 3), dtype=int)
array([[ True, False, False],
       [False,  True, False]], dtype=bool)

The numpy.fromfunction() method is used to construct an array by executing a function over each coordinate of the array.
In the above code, the function is defined using a lambda function that takes in two arguments i and j, which represent the row and column indices of the array, respectively.
The function returns True if the row index i is equal to the column index j, and False otherwise.
The shape of the resulting array is specified as (2, 3), meaning it has 2 rows and 3 columns. The dtype parameter is set to int to create an array of integers.
Finally the resulting array is a boolean array where the element at position (i,j) is True if i=j, and False otherwise.

Pictorial Presentation:

Example: Generating an array using a function with numpy.fromfunction()

>>> import numpy as np
>>> np.fromfunction(lambda i, j: i + j, (2, 3), dtype=int)
array([[0, 1, 2],
       [1, 2, 3]])

In the above code, we are using a lambda function that returns the sum of indices i and j as the value for each element of the resulting array. The resulting array has a shape of (2, 3), with two rows and three columns. The elements in the array are computed using the lambda function by passing the row and column indices to it.
The resulting array contains the sum of row and column indices at each position, with values 0, 1, 2, 1, 2, and 3 for each element in the array, respectively. The resulting array has a dtype of int, which is specified using the dtype parameter of the method.

Pictorial Presentation:

Python - Numpy Code Editor:

Previous: copy()
Next: fromiter()