FileBackedHashSetT Class

Represents a lookup table backed by a file, with very little memory overhead.

Inheritance Hierarchy

SystemObject
GSF.CollectionsFileBackedHashSetT

Namespace: GSF.Collections
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

C++

JavaScript

Copy

public sealed class FileBackedHashSet<T> : ISet<T>, 
	ICollection<T>, IEnumerable<T>, IEnumerable, IDisposable

Public NotInheritable Class FileBackedHashSet(Of T)
	Implements ISet(Of T), ICollection(Of T), 
	IEnumerable(Of T), IEnumerable, IDisposable

generic<typename T>
public ref class FileBackedHashSet sealed : ISet<T>, 
	ICollection<T>, IEnumerable<T>, IEnumerable, IDisposable

[<SealedAttribute>]
type FileBackedHashSet<'T> = 
    class
        interface ISet<'T>
        interface ICollection<'T>
        interface IEnumerable<'T>
        interface IEnumerable
        interface IDisposable
    end

JavaScript does not support generic types or methods.

View Source

Type Parameters

T: The type of the items in the lookup table.

The FileBackedHashSetT type exposes the following members.

Constructors

	Name	Description
	FileBackedHashSetT	Creates a new instance of the FileBackedHashSetT class.
	FileBackedHashSetT(IEnumerableT)	Creates a new instance of the FileBackedHashSetT class.
	FileBackedHashSetT(IEqualityComparerT)	Creates a new instance of the FileBackedHashSetT class.
	FileBackedHashSetT(String)	Creates a new instance of the FileBackedHashSetT class.
	FileBackedHashSetT(IEnumerableT, IEqualityComparerT)	Creates a new instance of the FileBackedHashSetT class.
	FileBackedHashSetT(String, IEnumerableT)	Creates a new instance of the FileBackedHashSetT class.
	FileBackedHashSetT(String, IEqualityComparerT)	Creates a new instance of the FileBackedHashSetT class.
	FileBackedHashSetT(String, IEnumerableT, IEqualityComparerT)	Creates a new instance of the FileBackedHashSetT class.

Top

Properties

	Name	Description
	CacheSize	Gets or sets the size of the cache used to store data from the file in memory.
	Count	Gets the number of elements contained in the FileBackedHashSetT.
	DefaultSignature	Gets the default signature used by the FileBackedHashSetT if no user-defined signature is supplied.
	FilePath	Gets or sets the path to the file backing this hash set.
	FragmentationCount	Gets the number of operations that fragment the lookup table that have occurred since the last time the lookup table was compacted.
	IsReadOnly	Gets a value indicating whether the FileBackedHashSetT is read-only.
	Signature	Gets or sets the signature of the file backing the lookup table.

Top

Methods

	Name	Description
	Add	Adds an element to the current set and returns a value to indicate if the element was successfully added.
	Clear	Removes all items from the FileBackedHashSetT.
	Close	Closes the file backing this hash set.
	Compact	Defragments the item section of the hash set, which gets fragmented after removing items.
	Contains	Determines whether the FileBackedHashSetT contains a specific value.
	CopyTo	Copies the elements of the FileBackedHashSetT to an Array, starting at a particular Array index.
	Dispose	Releases all the resources used by the FileBackedHashSetT object.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExceptWith	Removes all elements in the specified collection from the current set.
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IntersectWith	Modifies the current set so that it contains only elements that are also in a specified collection.
	IsProperSubsetOf	Determines whether the current set is a proper (strict) subset of a specified collection.
	IsProperSupersetOf	Determines whether the current set is a proper (strict) superset of a specified collection.
	IsSubsetOf	Determines whether a set is a subset of a specified collection.
	IsSupersetOf	Determines whether the current set is a superset of a specified collection.
	Open	Opens the file backing this hash set.
	OpenRead	Opens the file backing this hash set in read-only mode.
	Overlaps	Determines whether the current set overlaps with the specified collection.
	Remove	Removes the first occurrence of a specific object from the FileBackedHashSetT.
	RemoveWhere	Removes all elements that match the conditions defined by the specified predicate from a FileBackedHashSetT collection.
	SetEquals	Determines whether the current set and the specified collection contain the same elements.
	SymmetricExceptWith	Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	UnionWith	Modifies the current set so that it contains all elements that are present in either the current set or the specified collection.

Top

Extension Methods

	Name	Description
	AllParallelT	Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel. (Defined by CollectionExtensions)
	DistinctByT, TKey	Returns only the elements whose keys are distinct. (Defined by CollectionExtensions)
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	MajorityT	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityT	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByT, TKey	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByT, TKey	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MaxT	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxT	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxByT, TKey	Selects the largest item from the enumeration. (Defined by CollectionExtensions)
	MedianT	Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MiddleT	Gets the middle item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MinT	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinT	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinByT, TKey	Selects the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinorityT	Returns the minority value in the collection, or default type value if no item represents the minority. (Defined by CollectionExtensions)
	MinorityT	Returns the minority value in the collection, or defaultValue if no item represents the minority. (Defined by CollectionExtensions)
	MinorityByT, TKey	Returns the minority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MinorityByT, TKey	Returns the minority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	StandardDeviationT	Computes the standard deviation over a sequence of Double values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationT	Computes the standard deviation over a sequence of Decimal values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationT	Computes the standard deviation over a sequence of Single values. (Defined by NumericalAnalysisExtensions)
	ToDelimitedStringT	Converts an enumeration to a string, using the default delimiter ("\|") that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringT	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringT	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToPagedListT	Gets a PagedListT to paginate source enumeration for a given page and specified pageSize. (Defined by CollectionExtensions)

Top

Reference

GSF.Collections Namespace