Huffman.Compressor 1.0.0

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package Huffman.Compressor --version 1.0.0
                    


                    

                
NuGet\Install-Package Huffman.Compressor -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Huffman.Compressor" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Huffman.Compressor" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Huffman.Compressor" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Huffman.Compressor --version 1.0.0
                    


                    

                
#r "nuget: Huffman.Compressor, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Huffman.Compressor@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Huffman.Compressor&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Huffman.Compressor&version=1.0.0
                    


                            Install as a Cake Tool

Huffman

Huffman — це C#-бібліотека для кодування та декодування тексту за алгоритмом Хаффмана. Репозиторій містить основну бібліотеку та автоматичні тести.

Склад репозиторію

  • Huffman Compressor — основна бібліотека з API для побудови дерева, кодування та декодування.
  • Huffman.Tests — набір автоматичних xUnit-тестів для основних сценаріїв і крайових випадків.
  • Huffman.slnx — solution-файл у сучасному форматі .slnx.

Що вміє бібліотека

  • будує Huffman-дерево на основі вхідного тексту;
  • генерує таблицю кодів для символів;
  • кодує рядок у BitArray;
  • декодує бітову послідовність назад у вихідний текст;
  • перевіряє помилки використання API, зокрема порожній ввід, відсутню побудову дерева та некоректну бітову послідовність.

Вимоги

  • .NET SDK 10 або новіший.

Перевірити встановлені SDK:

dotnet --list-sdks

Збірка

dotnet build .\Huffman.slnx

Запуск тестів

dotnet test .\Huffman.slnx

Використання бібліотеки

using Huffman.Compressor;

var codec = new HuffmanCodec();
codec.Build("hello world");

var encoded = codec.Encode("hello world");
var decoded = codec.Decode(encoded);

Console.WriteLine(decoded); // hello world

Автоматичні перевірки

У тестовому проєкті вже покриті такі сценарії:

  • round-trip для звичайного тексту;
  • round-trip для рядка з одного символу;
  • помилка на порожньому джерелі;
  • помилка під час кодування символів поза поточним деревом;
  • помилка на неповній бітовій послідовності;
  • помилка при виклику Encode до Build.

Структура

Huffman/
|-- Directory.Build.props
|-- LICENCE
|-- README.md
|-- Huffman.slnx
|-- Huffman Compressor/
|   |-- Huffman.Compressor.csproj
|   |-- HuffmanEncryption.cs
|   `-- Node.cs
`-- Huffman.Tests/
    |-- Huffman.Tests.csproj
    `-- HuffmanCodecTests.cs

API-нотатка

Клас HuffmanEncryption збережено лише для сумісності зі старішим кодом і позначено як legacy-ім'я. Для нового коду варто використовувати HuffmanCodec.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net10.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 97 5/5/2026

Initial NuGet release of the Huffman codec library with automated tests and package documentation.