Skip to content

Fix some Tensor docs #115548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 19, 2025
Merged

Fix some Tensor docs #115548

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb92efc
fix tensor docs
gewarren May 14, 2025
82ddfce
fix a couple more from Copilot review
gewarren May 14, 2025
578baf2
exception verbiage
gewarren May 14, 2025
1784d51
Merge branch 'main' into docs0513
gewarren May 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 26 additions & 26 deletions src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4203,7 +4203,7 @@ public static ref readonly TensorSpan<T> LogP1<T>(scoped in ReadOnlyTensorSpan<T

#region Max
/// <summary>Searches for the largest number in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>..</param>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>.</param>
public static T Max<T>(scoped in ReadOnlyTensorSpan<T> x)
where T : INumber<T>
{
Expand Down Expand Up @@ -4266,7 +4266,7 @@ public static ref readonly TensorSpan<T> Max<T>(scoped in ReadOnlyTensorSpan<T>

#region MaxMagnitude
/// <summary>Searches for the number with the largest magnitude in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>..</param>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>.</param>
public static T MaxMagnitude<T>(scoped in ReadOnlyTensorSpan<T> x)
where T : INumber<T>
{
Expand Down Expand Up @@ -4329,7 +4329,7 @@ public static ref readonly TensorSpan<T> MaxMagnitude<T>(scoped in ReadOnlyTenso

#region MaxMagnitudeNumber
/// <summary>Searches for the number with the largest magnitude in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>..</param>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>.</param>
public static T MaxMagnitudeNumber<T>(scoped in ReadOnlyTensorSpan<T> x)
where T : INumberBase<T>
{
Expand Down Expand Up @@ -4392,7 +4392,7 @@ public static ref readonly TensorSpan<T> MaxMagnitudeNumber<T>(scoped in ReadOnl

#region MaxNumber
/// <summary>Searches for the largest number in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>..</param>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>.</param>
public static T MaxNumber<T>(scoped in ReadOnlyTensorSpan<T> x)
where T : INumber<T>
{
Expand Down Expand Up @@ -4455,7 +4455,7 @@ public static ref readonly TensorSpan<T> MaxNumber<T>(scoped in ReadOnlyTensorSp

#region Min
/// <summary>Searches for the largest number in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>..</param>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>.</param>
public static T Min<T>(scoped in ReadOnlyTensorSpan<T> x)
where T : INumber<T>
{
Expand All @@ -4469,7 +4469,7 @@ public static T Min<T>(scoped in ReadOnlyTensorSpan<T> x)
return result;
}

/// <summary>Computes the element-wise Minimum of the numbers in the specified tensors.</summary>
/// <summary>Computes the element-wise minimum of the numbers in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
public static Tensor<T> Min<T>(in ReadOnlyTensorSpan<T> x, in ReadOnlyTensorSpan<T> y)
Expand All @@ -4480,7 +4480,7 @@ public static Tensor<T> Min<T>(in ReadOnlyTensorSpan<T> x, in ReadOnlyTensorSpan
return output;
}

/// <summary>Computes the element-wise Minimum of the numbers in the specified tensors.</summary>
/// <summary>Computes the element-wise minimum of the numbers in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
/// <param name="destination">The destination tensor, represented as a span.</param>
Expand All @@ -4492,7 +4492,7 @@ public static ref readonly TensorSpan<T> Min<T>(scoped in ReadOnlyTensorSpan<T>
return ref destination;
}

/// <summary>Computes the element-wise Minimum of the numbers in the specified tensors.</summary>
/// <summary>Computes the element-wise minimum of the numbers in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
public static Tensor<T> Min<T>(in ReadOnlyTensorSpan<T> x, T y)
Expand All @@ -4503,7 +4503,7 @@ public static Tensor<T> Min<T>(in ReadOnlyTensorSpan<T> x, T y)
return destination;
}

/// <summary>Computes the element-wise Minimum of the numbers in the specified tensors.</summary>
/// <summary>Computes the element-wise minimum of the numbers in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
/// <param name="destination">The destination tensor, represented as a span.</param>
Expand All @@ -4517,8 +4517,8 @@ public static ref readonly TensorSpan<T> Min<T>(scoped in ReadOnlyTensorSpan<T>
#endregion

#region MinMagnitude
/// <summary>Searches for the number with the largest magnitude in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>..</param>
/// <summary>Searches for the number with the smallest magnitude in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>.</param>
public static T MinMagnitude<T>(scoped in ReadOnlyTensorSpan<T> x)
where T : INumber<T>
{
Expand All @@ -4532,7 +4532,7 @@ public static T MinMagnitude<T>(scoped in ReadOnlyTensorSpan<T> x)
return result;
}

/// <summary>Computes the element-wise number with the largest magnitude in the specified tensors.</summary>
/// <summary>Computes the element-wise number with the smallest magnitude in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
public static Tensor<T> MinMagnitude<T>(in ReadOnlyTensorSpan<T> x, in ReadOnlyTensorSpan<T> y)
Expand All @@ -4543,7 +4543,7 @@ public static Tensor<T> MinMagnitude<T>(in ReadOnlyTensorSpan<T> x, in ReadOnlyT
return destination;
}

/// <summary>Computes the element-wise number with the largest magnitude in the specified tensors.</summary>
/// <summary>Computes the element-wise number with the smallest magnitude in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
/// <param name="destination">The destination tensor, represented as a span.</param>
Expand All @@ -4555,7 +4555,7 @@ public static ref readonly TensorSpan<T> MinMagnitude<T>(scoped in ReadOnlyTenso
return ref destination;
}

/// <summary>Computes the element-wise number with the largest magnitude in the specified tensors.</summary>
/// <summary>Computes the element-wise number with the smallest magnitude in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
public static Tensor<T> MinMagnitude<T>(in ReadOnlyTensorSpan<T> x, T y)
Expand All @@ -4566,7 +4566,7 @@ public static Tensor<T> MinMagnitude<T>(in ReadOnlyTensorSpan<T> x, T y)
return destination;
}

/// <summary>Computes the element-wise number with the largest magnitude in the specified tensors.</summary>
/// <summary>Computes the element-wise number with the smallest magnitude in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
/// <param name="destination">The destination tensor, represented as a span.</param>
Expand All @@ -4580,8 +4580,8 @@ public static ref readonly TensorSpan<T> MinMagnitude<T>(scoped in ReadOnlyTenso
#endregion

#region MinMagnitudeNumber
/// <summary>Searches for the number with the largest magnitude in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>..</param>
/// <summary>Searches for the number with the smallest magnitude in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>.</param>
public static T MinMagnitudeNumber<T>(scoped in ReadOnlyTensorSpan<T> x)
where T : INumberBase<T>
{
Expand All @@ -4595,7 +4595,7 @@ public static T MinMagnitudeNumber<T>(scoped in ReadOnlyTensorSpan<T> x)
return result;
}

/// <summary>Computes the element-wise number with the largest magnitude in the specified tensors.</summary>
/// <summary>Computes the element-wise number with the smallest magnitude in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
public static Tensor<T> MinMagnitudeNumber<T>(in ReadOnlyTensorSpan<T> x, in ReadOnlyTensorSpan<T> y)
Expand All @@ -4606,7 +4606,7 @@ public static Tensor<T> MinMagnitudeNumber<T>(in ReadOnlyTensorSpan<T> x, in Rea
return destination;
}

/// <summary>Computes the element-wise number with the largest magnitude in the specified tensors.</summary>
/// <summary>Computes the element-wise number with the smallest magnitude in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
/// <param name="destination">The destination tensor, represented as a span.</param>
Expand All @@ -4618,7 +4618,7 @@ public static ref readonly TensorSpan<T> MinMagnitudeNumber<T>(scoped in ReadOnl
return ref destination;
}

/// <summary>Computes the element-wise number with the largest magnitude in the specified tensors.</summary>
/// <summary>Computes the element-wise number with the smallest magnitude in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
public static Tensor<T> MinMagnitudeNumber<T>(in ReadOnlyTensorSpan<T> x, T y)
Expand All @@ -4629,7 +4629,7 @@ public static Tensor<T> MinMagnitudeNumber<T>(in ReadOnlyTensorSpan<T> x, T y)
return destination;
}

/// <summary>Computes the element-wise number with the largest magnitude in the specified tensors.</summary>
/// <summary>Computes the element-wise number with the smallest magnitude in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
/// <param name="destination">The destination tensor, represented as a span.</param>
Expand All @@ -4644,7 +4644,7 @@ public static ref readonly TensorSpan<T> MinMagnitudeNumber<T>(scoped in ReadOnl

#region MinNumber
/// <summary>Searches for the largest number in the specified tensor.</summary>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>..</param>
/// <param name="x">The input <see cref="ReadOnlyTensorSpan{T}"/>.</param>
public static T MinNumber<T>(scoped in ReadOnlyTensorSpan<T> x)
where T : INumber<T>
{
Expand All @@ -4658,7 +4658,7 @@ public static T MinNumber<T>(scoped in ReadOnlyTensorSpan<T> x)
return result;
}

/// <summary>Computes the element-wise Minimum of the numbers in the specified tensors.</summary>
/// <summary>Computes the element-wise minimum of the numbers in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
public static Tensor<T> MinNumber<T>(in ReadOnlyTensorSpan<T> x, in ReadOnlyTensorSpan<T> y)
Expand All @@ -4669,7 +4669,7 @@ public static Tensor<T> MinNumber<T>(in ReadOnlyTensorSpan<T> x, in ReadOnlyTens
return destination;
}

/// <summary>Computes the element-wise Minimum of the numbers in the specified tensors.</summary>
/// <summary>Computes the element-wise minimum of the numbers in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
/// <param name="destination">The destination tensor, represented as a span.</param>
Expand All @@ -4681,7 +4681,7 @@ public static ref readonly TensorSpan<T> MinNumber<T>(scoped in ReadOnlyTensorSp
return ref destination;
}

/// <summary>Computes the element-wise Minimum of the numbers in the specified tensors.</summary>
/// <summary>Computes the element-wise minimum of the numbers in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
public static Tensor<T> MinNumber<T>(in ReadOnlyTensorSpan<T> x, T y)
Expand All @@ -4692,7 +4692,7 @@ public static Tensor<T> MinNumber<T>(in ReadOnlyTensorSpan<T> x, T y)
return destination;
}

/// <summary>Computes the element-wise Minimum of the numbers in the specified tensors.</summary>
/// <summary>Computes the element-wise minimum of the numbers in the specified tensors.</summary>
/// <param name="x">The first tensor, represented as a span.</param>
/// <param name="y">The second tensor, represented as a span.</param>
/// <param name="destination">The destination tensor, represented as a span.</param>
Expand Down
Loading