Share via

ITensor<TSelf,T> Interface

Definition

Namespace:
System.Numerics.Tensors
Assembly:
System.Numerics.Tensors.dll
Package:
System.Numerics.Tensors v10.0.0-preview.6.25358.103
Source:
ITensor_1.cs
Source:
ITensor.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a tensor.

C# 
[System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5001", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
public interface ITensor<TSelf,T> : System.Collections.Generic.IEnumerable<T>, System.Numerics.Tensors.IReadOnlyTensor<TSelf,T>, System.Numerics.Tensors.ITensor where TSelf : ITensor<TSelf,T>

Type Parameters

TSelf

The type that implements this interface.

T

The element type.

Derived
Attributes
ExperimentalAttribute
Implements
IEnumerable<T> IEnumerable IReadOnlyTensor IReadOnlyTensor<TSelf,T> ITensor

Properties

FlattenedLength

Gets the total number of items in the tensor.

(Inherited from IReadOnlyTensor)
HasAnyDenseDimensions

Determines if the current tensor has any dimension where GetDimensionSpan(int) will iterate through tensors that would have IsDense be true.

(Inherited from IReadOnlyTensor)
IsDense

Determines if the current tensor is dense.

(Inherited from IReadOnlyTensor)
IsEmpty

Gets a value indicating whether this tensor is empty.

(Inherited from IReadOnlyTensor)
IsPinned

Gets a value that indicates whether the underlying buffer is pinned.

(Inherited from IReadOnlyTensor)
IsReadOnly

Gets a value that indicates whether the tensor is read-only.

(Inherited from ITensor)
Item[ReadOnlySpan<IntPtr>]

Gets the value at the specified indexes.
Item[ReadOnlySpan<NIndex>]

Gets the value at the specified indexes.
Item[ReadOnlySpan<NRange>]

Gets or sets a slice out of the current tensor that contains a specified range.
Lengths

Gets the length of each dimension in the tensor.

(Inherited from IReadOnlyTensor)
Rank

Gets the rank, or number of dimensions, in the tensor.

(Inherited from IReadOnlyTensor)
Strides

Gets the stride of each dimension in the tensor.

(Inherited from IReadOnlyTensor)

Methods

AsReadOnlyTensorSpan()

Creates a new readonly tensor span over the tensor.

(Inherited from IReadOnlyTensor<TSelf,T>)
AsReadOnlyTensorSpan(ReadOnlySpan<IntPtr>)

Creates a new readonly tensor span over a portion of the tensor starting at a specified position to the end of the tensor.

(Inherited from IReadOnlyTensor<TSelf,T>)
AsReadOnlyTensorSpan(ReadOnlySpan<NIndex>)

Creates a read-only tensor span for the specified start indexes.

(Inherited from IReadOnlyTensor<TSelf,T>)
AsReadOnlyTensorSpan(ReadOnlySpan<NRange>)

Creates a new readonly tensor span over a portion of the tensor defined by the specified range.

(Inherited from IReadOnlyTensor<TSelf,T>)
AsTensorSpan()

Creates a new tensor span over the tensor.
AsTensorSpan(ReadOnlySpan<IntPtr>)

Creates a new tensor span over a portion of the tensor starting at a specified position to the end of the tensor.
AsTensorSpan(ReadOnlySpan<NIndex>)

Creates a tensor span for the specified start indexes.
AsTensorSpan(ReadOnlySpan<NRange>)

Creates a new tensor span over a portion of the tensor defined by the specified range.
Clear()

Clears the contents of the tensor span.

(Inherited from ITensor)
CopyTo(TensorSpan<T>)

Copies the contents of the tensor into a destination tensor span.

(Inherited from IReadOnlyTensor<TSelf,T>)
Create(ReadOnlySpan<IntPtr>, Boolean)

Creates a new tensor with the specified lengths.
Create(ReadOnlySpan<IntPtr>, ReadOnlySpan<IntPtr>, Boolean)

Creates a new tensor with the specified lengths and strides.
CreateUninitialized(ReadOnlySpan<IntPtr>, Boolean)

Creates a new tensor with the specified lengths and strides.
CreateUninitialized(ReadOnlySpan<IntPtr>, ReadOnlySpan<IntPtr>, Boolean)

Creates a new tensor with the specified lengths and strides. If pinned is true the underlying buffer is created permanently pinned, otherwise the underlying buffer is not pinned. The underlying buffer is not initialized.
Fill(Object)

Fills the elements of this tensor with a specified value.

(Inherited from ITensor)
Fill(T)

Fills the contents of this tensor with the given value.
FlattenTo(Span<T>)

Flattens the contents of the tensor into a destination span.

(Inherited from IReadOnlyTensor<TSelf,T>)
GetDimensionSpan(Int32)

Returns a span that can be used to access the flattened elements for a given dimension.
GetEnumerator()

Returns an enumerator that iterates through a collection.

(Inherited from IEnumerable)
GetPinnableReference()

Returns a reference to the 0th element of the tensor. If the tensor is empty, returns null.
GetPinnedHandle()

Pins and gets a MemoryHandle to the backing memory.

(Inherited from IReadOnlyTensor)
Slice(ReadOnlySpan<IntPtr>)

Forms a slice out of the current tensor that begins at a specified index.

(Inherited from IReadOnlyTensor<TSelf,T>)
Slice(ReadOnlySpan<NIndex>)

Slices the tensor using the specified start indexes.

(Inherited from IReadOnlyTensor<TSelf,T>)
Slice(ReadOnlySpan<NRange>)

Gets a slice out of the current tensor that contains a specified range.

(Inherited from IReadOnlyTensor<TSelf,T>)
ToDenseTensor()

Creates a dense tensor from the elements of the current tensor.

(Inherited from IReadOnlyTensor<TSelf,T>)
TryCopyTo(TensorSpan<T>)

Attempts to copy the contents of this tensor into a destination tensor span and returns a value to indicate whether or not the operation succeeded.

(Inherited from IReadOnlyTensor<TSelf,T>)
TryFlattenTo(Span<T>)

Attempts to flatten the contents of this tensor into a destination span and returns a value to indicate whether or not the operation succeeded.

(Inherited from IReadOnlyTensor<TSelf,T>)

Extension Methods

ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)

Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector function.
ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>)

Creates a FrozenDictionary<TKey,TValue> from an IEnumerable<T> according to specified key selector and element selector functions.
ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>)

Creates a FrozenSet<T> with the specified values.
ToImmutableArray<TSource>(IEnumerable<TSource>)

Creates an immutable array from the specified collection.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)

Constructs an immutable dictionary based on some transformation of a sequence.
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)

Constructs an immutable dictionary from an existing collection of elements, applying a transformation function to the source keys.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>)

Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key and value comparers.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>)

Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key comparer.
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)

Enumerates and transforms a sequence, and produces an immutable dictionary of its contents.
ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>)

Enumerates a sequence, produces an immutable hash set of its contents, and uses the specified equality comparer for the set type.
ToImmutableHashSet<TSource>(IEnumerable<TSource>)

Enumerates a sequence and produces an immutable hash set of its contents.
ToImmutableList<TSource>(IEnumerable<TSource>)

Enumerates a sequence and produces an immutable list of its contents.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>)

Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key and value comparers.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>)

Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key comparer.
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)

Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>)

Enumerates a sequence, produces an immutable sorted set of its contents, and uses the specified comparer.
ToImmutableSortedSet<TSource>(IEnumerable<TSource>)

Enumerates a sequence and produces an immutable sorted set of its contents.
ToAsyncEnumerable<TSource>(IEnumerable<TSource>)

Creates a new IAsyncEnumerable<T> that iterates through source.

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)