Oakrey.Collections 1.0.0

Oakrey.Collections

Overview

The Collections project is a comprehensive library of advanced collection types and utility extensions designed to enhance the functionality of standard .NET collections. The project provides thread-safe, observable, and specialized collection implementations, as well as statistical and utility extensions for common collection operations.

Key Features

Advanced Collection Types:

• UniqueNameList<T>: A list ensuring unique Name properties for items implementing the IName interface.
• TrulyObservableCollection<T>: An observable collection that tracks property changes of its items.
• LockedList<T> and LockedDictionary<TKey, TValue>: Thread-safe implementations of List and Dictionary.
• SelfFillingQueue<T>: A queue that auto-fills itself using a provided function when capacity is reached.
• FixedSizedQueue<T>: A queue with a fixed size that automatically removes the oldest items when the limit is exceeded.
• Histogram<TKey>: A sorted dictionary for recording and counting occurrences of keys.

Utility Extensions:

• QueueExtensions and StackExtensions: Extensions for batch operations like EnqueueRange, DequeueRange, PushRange, and PopRange.
• DictionaryExtensions: Iteration utilities for dictionaries.
• ByteArrayExtensions: Padding operations for byte arrays.
• QueueFluentExtensions: Fluent-style methods for appending and prepending items to queues.

Statistical Operations:

• StatisticExtensions: Provides statistical methods like Median, Mode, Variance, StandardDeviation, and moving averages for numeric collections.

Observable and Event-Driven Features:

• ObservableKeyValuePair<TKey, TValue>: A key-value pair that notifies property changes.
• CollectionsItemPropertyChangedEventArgs: Event arguments for tracking property changes in collection items.

Error Handling:

• CollectionException and Extensions: Custom exceptions and utilities for validating collection states.

Object Management:

• ObjectCache<T>: A cache for managing object lifetimes with reference counting and custom release actions.

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

1. Open your project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
3. Search for Oakrey.Collections and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Collections

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Collections

Requirements

• .NET 8 or higher

Project Information

• Author: Oakrey
• Company: Oakrey
• License: MIT
• Repository: Git Repository
• Project URL: Project Website

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.