For the complete Mojo documentation index, see llms.txt. Markdown versions of all pages are available by appending .md to any URL (e.g. /docs/manual/basics.md).
mean
mean[dtype: DType, input_fn: def[width: Int, rank: Int](IndexList[rank]) capturing -> SIMD[dtype, width], output_fn: def[width: Int, rank: Int](IndexList[rank], SIMD[dtype, width]) capturing -> None, /, single_thread_blocking_override: Bool = False, target: StringSlice[StaticConstantOrigin] = StringSlice("cpu")](input_shape: IndexList, reduce_dim: Int, output_shape: IndexList[input_shape.size], context: DeviceContextPtr = DeviceContextPtr())
Computes the mean across the input and output shape.
This performs the mean computation on the domain specified by input_shape,
loading the inputs using the input_fn. The results' domain is
output_shape which are stored using the output_fn.
Parameters:
- dtype (
DType): The dtype of the input and output. - input_fn (
def[width: Int, rank: Int](IndexList[rank]) capturing -> SIMD[dtype, width]): The function to load the input. - output_fn (
def[width: Int, rank: Int](IndexList[rank], SIMD[dtype, width]) capturing -> None): The function to store the output. - single_thread_blocking_override (
Bool): If True, then the operation is run synchronously using a single thread. - target (
StringSlice[StaticConstantOrigin]): The target to run on.
Args:
- input_shape (
IndexList): The input shape. - reduce_dim (
Int): The axis to perform the mean on. - output_shape (
IndexList[input_shape.size]): The output shape. - context (
DeviceContextPtr): The pointer to DeviceContext.
Raises:
If the operation fails.
mean[dtype: DType](src: Span[Scalar[dtype]]) -> Scalar[dtype]
Computes the mean value of the elements in a buffer.
Parameters:
- dtype (
DType): The dtype of the input.
Args:
- src (
Span[Scalar[dtype]]): The buffer of elements for which the mean is computed.
Returns:
Scalar[dtype]: The mean value of the elements in the given buffer.
Raises:
If the operation fails.
mean[dtype: DType, input_fn_1d: def[dtype_: DType, width: Int](idx: Int) capturing -> SIMD[dtype_, width]](length: Int) -> Scalar[dtype]
Computes the arithmetic mean of values generated by a function.
Parameters:
- dtype (
DType): The data type of the elements. - input_fn_1d (
def[dtype_: DType, width: Int](idx: Int) capturing -> SIMD[dtype_, width]): A function that generates SIMD values at each index.
Args:
- length (
Int): The number of elements to average.
Returns:
Scalar[dtype]: The mean value. For integral types, uses integer division.
Raises:
To comply with how generators are used in this module.