ILNumerics Ultimate VS

ILNumerics Namespace

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
The main ILNumerics namespace should be imported into your project. Most important types are the array types and the ILMath class, which contains the main computational functions. It is convenient to import the ILMath class ('using static ILNumerics.ILMath;'). Corresponding online documentation is found here: https://ilnumerics.net/docs.html. A getting started guide: https://ilnumerics.net/general-usage_v5.html.
Classes

  ClassDescription
Public classCode exampleArrayT
The main n-dimensional, rectilinear array to be used in algorithms.

[ILNumerics Core Module]

Public classBaseArray
General base class of any ILNumerics array. This class is abstract.

[ILNumerics Core Module]

Public classBaseArrayT
Public classCell
Cell array is a container for arrays.

[ILNumerics Core Module]

Public classDimSpec
Class representing a one-dimensional slice / range or single index along a dimension. Used for subarray indexing.

[ILNumerics Core Module]

Public classEllipsisSpec
This class supports the ellipsis keyword in indexing operations.

[ILNumerics Core Module]

Public classEndExpression
Static class defining useful constants, shortcuts, aliases and functions for working with ILNumerics arrays.

[ILNumerics Core Module]

Public classExpressionDimSpec
This class supports ranges / dimension specifiers defined with 'end' expressions.

[ILNumerics Core Module]

Public classExtensionMethods
Importing this class / its namespace makes the array methods from the [numpy API] visible on suitable arrays.

[ILNumerics numpy Module]

Public classFullDimSpec
This class supports the full specifier in indexing expressions.

[ILNumerics Core Module]

Public classGlobals
Static class defining useful constants, shortcuts, aliases and functions for working with ILNumerics arrays.

[ILNumerics Core Module]

Public classILMath
Main math class, exposes static array functions. Import all methods from this class by adding "using static ILNumerics.ILMath;" (C#) to gain access to all functions without the class qualifier.

[ILNumerics Computing Engine]

Public classInArrayT
Main input array type. Use this in a function signature indicating an immutable, dense input array as function argument.

[ILNumerics Core Module]

Public classInCell
Input cell array type to be used as input parameter in user defined functions.

[ILNumerics Core Module]

Public classInLogical
Input logical array type to be used as input parameter in user defined functions.

[ILNumerics Core Module]

Public classLogical
Local logical array type to be used when defining local array variables in custom algorithms.

[ILNumerics Core Module]

Public classCode exampleMatFile
Matlab(R) .mat file class for reading from / writing to *.mat files.

[ILNumerics Core Module]

Public classNewaxisSpec
This class supports the newaxis keywords in numpy index expressions.

[ILNumerics Core Module]

Public classnumpy
This class extends ILNumerics arrays with numpy semantics and gives access to further computational methods.

[ILNumerics numpy Module]

Public classOutArrayT
Input /output array type to be used as parameter in user defined functions with multiple return values.

[ILNumerics Core Module]

Public classOutCell
Input /output cell array type to be used as parameter in user defined functions with multiple return values.

[ILNumerics Core Module]

Public classOutLogical
Input /output logical array type to be used as parameter in user defined functions with multiple return values.

[ILNumerics Core Module]

Public classResultT
Result datatype, used for storing computational results and applying them to new data within ILNumerics stateful function objects.

[ILNumerics Core Module]

Public classResultTin, Tout
Result datatype, used for storing computational results and applying them to new data within ILNumerics stateful function objects

[ILNumerics Core Module]

Public classRetArrayT1
Array type to be used as return type for user defined functions.

[ILNumerics Core Module]

Public classRetCell
Cell array type to be used as return type for user defined functions.

[ILNumerics Core Module]

Public classRetLogical
Logical array type to be used as return type for user defined functions.

[ILNumerics Core Module]

Public classScope
An artificial scope class, used by the ILNumerics memory management

[ILNumerics Core Module]

Public classSettings
The class provides static setting properties to control the behaviour of ILNumerics, see Configuration in the online documentation

[ILNumerics Core Module]

Public classSize
Size - dimensions for array objects. This object is immutable.

[ILNumerics Core Module]

Public classSpecialData
A helper class that can be used to generate various simple but non-trivial test data sets.

[ILNumerics Core Module]

Public classVisibilityAttribute
This attribute is used to control the public API visibility of ILNumerics functions.

[ILNumerics Core Module]

Structures

  StructureDescription
Public structurecomplex
Floating point complex value data type of double precision.

[ILNumerics Core Module]

Public structureDeviceHintAttribute
Public structurefcomplex
Floating point complex value data type of float (single) precision

[ILNumerics Core Module]

Public structureMachineParameterDouble
Extensive numerical machine parameter infos - double precision

[ILNumerics Core Module]

Public structureMachineParameterSingle
Extensive numerical machine parameter infos - single precision

[ILNumerics Core Module]

Interfaces

  InterfaceDescription
Public interfaceIIndexIterator
Interface for objects usable as index iterators in subarray expressions.

[ILNumerics Core Module]

Enumerations

  EnumerationDescription
Public enumerationArrayStreamSerializationFlags
Defines the way Arrays are serialized to stream.

[ILNumerics Core Module]

Public enumerationArrayStyles
Options of array semantics. This enum is used to switch the behavior of ArrayT and Co. between ILNumerics version 4 (Matlab, Julia, etc.) and numpy mode.

[ILNumerics Core Module]

Public enumerationBuildConfig
Public enumerationDeviceTypes
All device types supported by OpenCL. These enum values match the official constants values according to the OpenCL spec 2.1.

[ILNumerics Core Module]

Public enumerationGenEigenType
Specifies the type of eigen problem, as defined by Lapack.

[ILNumerics Core Module]

Public enumerationKernelCodes
Public enumerationLogVerbosityLevels
Available levels of logging information during run time.

[ILNumerics Core Module]

Public enumerationMatFileMatFileArrayClass
Types for matrix chunks

[ILNumerics Core Module]

Public enumerationMatFileMatFileType
Inner types for MATLAB data elements

[ILNumerics Core Module]

Public enumerationMatrixProperties
Possible properties for matrices

[ILNumerics Core Module]

Public enumerationMemoryTypes
Individual types of memory available to store arrays and parts thereof.

[ILNumerics Core Module]

Public enumerationNumericType
Numeric, value type names used as data array elements by ILNumerics.

[ILNumerics Core Module]

Public enumerationPutModes
[numpy API] Options for handling out-of-range indices in 'ILNumerics.numpy.put(A, B, C, mode)'.

[ILNumerics Core Module]

Public enumerationStorageOrders
Supported known storage orders for array elements.

[ILNumerics Core Module]

Public enumerationVisibility
Attribute flag values for VisibilityAttribute.

[ILNumerics Core Module]