Class NpzDictionary<T>

Namespace

NumSharp

Assembly

NumSharp.dll

public class NpzDictionary<T> : IDisposable, IReadOnlyDictionary<string, T>, IReadOnlyCollection<KeyValuePair<string, T>>, IEnumerable<KeyValuePair<string, T>>, ICollection<T>, IEnumerable<T>, IEnumerable where T : class, ICloneable, IList, ICollection, IEnumerable, IStructuralComparable, IStructuralEquatable

Type Parameters

T

Inheritance

object

NpzDictionary<T>

Implements

IDisposable

IReadOnlyDictionary<string, T>

IReadOnlyCollection<KeyValuePair<string, T>>

IEnumerable<KeyValuePair<string, T>>

ICollection<T>

IEnumerable<T>

IEnumerable

Derived

NpzDictionary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

LinqExtensions.Yield<T>(T)

Constructors

NpzDictionary(Stream)

public NpzDictionary(Stream stream)

Parameters

stream Stream

Properties

Count

Gets the number of elements in the collection.

public int Count { get; }

Property Value

int

The number of elements in the collection.

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

public bool IsReadOnly { get; }

Property Value

bool

true if the ICollection<T> is read-only; otherwise, false.

IsSynchronized

public bool IsSynchronized { get; }

Property Value

bool

this[string]

Gets the element that has the specified key in the read-only dictionary.

public T this[string key] { get; }

Parameters

key string

The key to locate.

Property Value

T

The element that has the specified key in the read-only dictionary.

Exceptions

ArgumentNullException

key is null.

KeyNotFoundException

The property is retrieved and key is not found.

Keys

Gets an enumerable collection that contains the keys in the read-only dictionary.

public IEnumerable<string> Keys { get; }

Property Value

IEnumerable<string>

An enumerable collection that contains the keys in the read-only dictionary.

SyncRoot

public object SyncRoot { get; }

Property Value

object

Values

Gets an enumerable collection that contains the values in the read-only dictionary.

public IEnumerable<T> Values { get; }

Property Value

IEnumerable<T>

An enumerable collection that contains the values in the read-only dictionary.

Methods

Add(T)

Adds an item to the ICollection<T>.

public void Add(T item)

Parameters

item T

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(T)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(T item)

Parameters

item T

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

ContainsKey(string)

Determines whether the read-only dictionary contains an element that has the specified key.

public bool ContainsKey(string key)

Parameters

key string

The key to locate.

Returns

bool

true if the read-only dictionary contains an element that has the specified key; otherwise, false.

Exceptions

ArgumentNullException

key is null.

CopyTo(Array, int)

public void CopyTo(Array array, int arrayIndex)

Parameters

array Array

arrayIndex int

CopyTo(T[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(T[] array, int arrayIndex)

Parameters

array T[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<KeyValuePair<string, T>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<string, T>>

An enumerator that can be used to iterate through the collection.

Load_Npz(Stream)

protected virtual T Load_Npz(Stream s)

Parameters

s Stream

Returns

T

Remove(T)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(T item)

Parameters

item T

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

TryGetValue(string, out T)

Gets the value that is associated with the specified key.

public bool TryGetValue(string key, out T value)

Parameters

key string

The key to locate.

value T

When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

bool

true if the object that implements the IReadOnlyDictionary<TKey, TValue> interface contains an element that has the specified key; otherwise, false.

Exceptions

ArgumentNullException

key is null.