ILNumerics - Technical Application Development
Assembly: ILNumerics.numpy (in ILNumerics.numpy.dll) Version: 5.5.0.0 (5.5.7503.3146)
[numpy API] Remove specific or all singleton dimensions.
[ILNumerics numpy Module]
Namespace: ILNumerics
Assembly: ILNumerics.numpy (in ILNumerics.numpy.dll) Version: 5.5.0.0 (5.5.7503.3146)
Syntax
public static void squeeze<T1, LocalT, InT, OutT, RetT, StorageT>( this Mutable<T1, LocalT, InT, OutT, RetT, StorageT> A, InArray<long> axes = null ) where LocalT : Mutable<T1, LocalT, InT, OutT, RetT, StorageT> where InT : Immutable<T1, LocalT, InT, OutT, RetT, StorageT> where OutT : Mutable<T1, LocalT, InT, OutT, RetT, StorageT> where RetT : ConcreteRetArray<T1, LocalT, InT, OutT, RetT, StorageT> where StorageT : new(), BaseStorage<T1, LocalT, InT, OutT, RetT, StorageT>
Parameters
- A
- Type: ILNumerics.Core.ArraysMutableT1, LocalT, InT, OutT, RetT, StorageT
The array to be altered. - axes (Optional)
- Type: ILNumericsInArrayInt64
[Optional] Array with axis definition. This holds the indices of the axes to be removed. Default: (null) or empty: remove all singleton dimensions.
Type Parameters
- T1
- LocalT
- InT
- OutT
- RetT
- StorageT
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type MutableT1, LocalT, InT, OutT, RetT, StorageT. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Exceptions
Exception | Condition |
---|---|
ArgumentException | if any dimension index provided in axes points to a non-singleton dimension. |
Remarks
This function respect the value of MinNumberOfArrayDimensions. Thus, if ArrayStyle is ILNumericsV4 (default) at least 2 dimensions will remain in the array.
[ILNumerics numpy Module]
See Also