Merge branch 'main'

Merging branch main (from rider) to master
This commit is contained in:
MarcUs7i 2024-11-27 16:58:47 +01:00
commit 3a97899126
10 changed files with 5381 additions and 0 deletions

3551
.editorconfig Normal file

File diff suppressed because it is too large Load diff

678
.gitignore vendored Normal file
View file

@ -0,0 +1,678 @@
# Created by https://www.toptal.com/developers/gitignore/api/csharp,rider,visualstudio,visualstudiocode
# Edit at https://www.toptal.com/developers/gitignore?templates=csharp,rider,visualstudio,visualstudiocode
### Csharp ###
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Mono auto generated files
mono_crash.*
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Ww][Ii][Nn]32/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/
# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# Visual Studio 2017 auto generated files
Generated\ Files/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# Benchmark Results
BenchmarkDotNet.Artifacts/
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
# ASP.NET Scaffolding
ScaffoldingReadMe.txt
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.tlog
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# Visual Studio Trace Files
*.e2e
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# Coverlet is a free, cross platform Code Coverage Tool
coverage*.json
coverage*.xml
coverage*.info
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*- [Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio 6 auto-generated project file (contains which files were open etc.)
*.vbp
# Visual Studio 6 workspace and project file (working project files containing files to include in project)
*.dsw
*.dsp
# Visual Studio 6 technical files
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# CodeRush personal settings
.cr/personal
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
*.tss
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
# OpenCover UI analysis results
OpenCover/
# Azure Stream Analytics local run output
ASALocalRun/
# MSBuild Binary and Structured Log
*.binlog
# NVidia Nsight GPU debugger configuration file
*.nvuser
# MFractors (Xamarin productivity tool) working folder
.mfractor/
# Local History for Visual Studio
.localhistory/
# Visual Studio History (VSHistory) files
.vshistory/
# BeatPulse healthcheck temp database
healthchecksdb
# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
# Ionide (cross platform F# VS Code tools) working folder
.ionide/
# Fody - auto-generated XML schema
FodyWeavers.xsd
# VS Code files for those working on multiple tools
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace
# Local History for Visual Studio Code
.history/
# Windows Installer files from build outputs
*.cab
*.msi
*.msix
*.msm
*.msp
# JetBrains Rider
*.sln.iml
### Rider ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
## Just ignore the .idea folder
.idea/
# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf
# AWS User-specific
.idea/**/aws.xml
# Generated files
.idea/**/contentModel.xml
# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml
# Gradle
.idea/**/gradle.xml
.idea/**/libraries
# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn. Uncomment if using
# auto-import.
# .idea/artifacts
# .idea/compiler.xml
# .idea/jarRepositories.xml
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr
# CMake
cmake-build-*/
# Mongo Explorer plugin
.idea/**/mongoSettings.xml
# File-based project format
*.iws
# IntelliJ
out/
# mpeltonen/sbt-idea plugin
.idea_modules/
# JIRA plugin
atlassian-ide-plugin.xml
# Cursive Clojure plugin
.idea/replstate.xml
# SonarLint plugin
.idea/sonarlint/
# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties
# Editor-based Rest Client
.idea/httpRequests
# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser
### VisualStudioCode ###
!.vscode/*.code-snippets
# Local History for Visual Studio Code
# Built Visual Studio Code Extensions
*.vsix
### VisualStudioCode Patch ###
# Ignore all local history of files
.history
.ionide
### VisualStudio ###
# User-specific files
# User-specific files (MonoDevelop/Xamarin Studio)
# Mono auto generated files
# Build results
# Visual Studio 2015/2017 cache/options directory
# Uncomment if you have tasks that create the project's static files in wwwroot
# Visual Studio 2017 auto generated files
# MSTest test Results
# NUnit
# Build Results of an ATL Project
# Benchmark Results
# .NET Core
# ASP.NET Scaffolding
# StyleCop
# Files built by Visual Studio
# Chutzpah Test files
# Visual C++ cache files
# Visual Studio profiler
# Visual Studio Trace Files
# TFS 2012 Local Workspace
# Guidance Automation Toolkit
# ReSharper is a .NET coding add-in
# TeamCity is a build add-in
# DotCover is a Code Coverage Tool
# AxoCover is a Code Coverage Tool
# Coverlet is a free, cross platform Code Coverage Tool
# Visual Studio code coverage results
# NCrunch
# MightyMoose
# Web workbench (sass)
# Installshield output folder
# DocProject is a documentation generator add-in
# Click-Once directory
# Publish Web Output
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
# NuGet Packages
# NuGet Symbol Packages
# The packages folder can be ignored because of Package Restore
# except build/, which is used as an MSBuild target.
# Uncomment if necessary however generally it will be regenerated when needed
# NuGet v3's project.json files produces more ignorable files
# Microsoft Azure Build Output
# Microsoft Azure Emulator
# Windows Store app package directories and files
# Visual Studio cache files
# files ending in .cache can be ignored
# but keep track of directories ending in .cache
# Others
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
# RIA/Silverlight projects
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
# SQL Server files
# Business Intelligence projects
# Microsoft Fakes
# GhostDoc plugin setting file
# Node.js Tools for Visual Studio
# Visual Studio 6 build log
# Visual Studio 6 workspace options file
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
# Visual Studio 6 auto-generated project file (contains which files were open etc.)
# Visual Studio 6 workspace and project file (working project files containing files to include in project)
# Visual Studio 6 technical files
# Visual Studio LightSwitch build output
# Paket dependency manager
# FAKE - F# Make
# CodeRush personal settings
# Python Tools for Visual Studio (PTVS)
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
# Telerik's JustMock configuration file
# BizTalk build output
# OpenCover UI analysis results
# Azure Stream Analytics local run output
# MSBuild Binary and Structured Log
# NVidia Nsight GPU debugger configuration file
# MFractors (Xamarin productivity tool) working folder
# Local History for Visual Studio
# Visual Studio History (VSHistory) files
# BeatPulse healthcheck temp database
# Backup folder for Package Reference Convert tool in Visual Studio 2017
# Ionide (cross platform F# VS Code tools) working folder
# Fody - auto-generated XML schema
# VS Code files for those working on multiple tools
# Local History for Visual Studio Code
# Windows Installer files from build outputs
# JetBrains Rider
### VisualStudio Patch ###
# Additional files built by Visual Studio
# End of https://www.toptal.com/developers/gitignore/api/csharp,rider,visualstudio,visualstudiocode

View file

@ -0,0 +1,36 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<IsPackable>false</IsPackable>
</PropertyGroup>
<ItemGroup>
<Using Include="FluentAssertions" />
<Using Include="Xunit" />
<Using Include="NSubstitute" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="FluentAssertions" Version="6.12.2" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
<PackageReference Include="NSubstitute" Version="5.3.0" />
<PackageReference Include="xunit" Version="2.9.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="6.0.2">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\FlexArray\FlexArray.csproj" />
</ItemGroup>
</Project>

View file

@ -0,0 +1,339 @@
namespace FlexArray.Test;
public class FlexArrayIntTests
{
[Fact]
public void Construction_NoSize()
{
var array = new FlexArrayInt();
array.Should().NotBeNull();
array.Count.Should().Be(0, "no items added yet");
array.Capacity.Should().Be(FlexArrayInt.DefaultStartSize, "default capacity");
}
[Theory]
[InlineData(0)]
[InlineData(4)]
[InlineData(20)]
[InlineData(100_000)]
public void Construction_WithSize(int size)
{
var array = new FlexArrayInt(size);
array.Should().NotBeNull();
array.Count.Should().Be(0, "no items added yet");
array.Capacity.Should().Be(size, "initial capacity set to specified size");
}
[Fact]
public void Construction_WithInvalidSize()
{
var array = new FlexArrayInt(-5);
array.Should().NotBeNull();
array.Count.Should().Be(0);
array.Capacity.Should().Be(0, "negative size provided => set to 0");
}
[Fact]
public void AddItem_Single()
{
var array = new FlexArrayInt();
array.Add(17);
array.Count.Should().Be(1, "one item added");
array.Capacity.Should().Be(FlexArrayInt.DefaultStartSize, "capacity unchanged");
}
[Fact]
public void AddItem_Multiple_NoGrowth()
{
var array = new FlexArrayInt();
array.Add(17);
array.Add(20);
array.Add(-100);
array.Count.Should().Be(3, "three items added");
array.Capacity.Should().Be(FlexArrayInt.DefaultStartSize, "no growth required yet");
}
[Fact]
public void AddItem_Multiple_Growth()
{
var array = new FlexArrayInt();
void AddItems(int count)
{
for (var i = 0; i < count; i++)
{
array.Add(i + 1);
}
}
AddItems(FlexArrayInt.DefaultStartSize);
array.Capacity.Should().Be(FlexArrayInt.DefaultStartSize);
AddItems(2);
array.Capacity.Should().BeGreaterThan(FlexArrayInt.DefaultStartSize, "capacity exceeded, had to grow");
array.Count.Should().Be(FlexArrayInt.DefaultStartSize + 2);
}
[Fact]
public void Contains_Success()
{
var array = new FlexArrayInt();
array.Add(12);
array.Add(23);
array.Add(-900);
array.Add(76);
array.Contains(23)
.Should().BeTrue();
}
[Fact]
public void Contains_Success_AfterGrowth()
{
var array = new FlexArrayInt();
for (var i = 0; i <= FlexArrayInt.DefaultStartSize; i++)
{
array.Add(i);
}
array.Contains(FlexArrayInt.DefaultStartSize - 1)
.Should().BeTrue();
}
[Fact]
public void Contains_Empty()
{
var array = new FlexArrayInt();
array.Contains(23)
.Should().BeFalse("collection is empty");
}
[Fact]
public void Contains_NotFound()
{
var array = new FlexArrayInt();
array.Add(-12);
array.Add(23);
array.Contains(12)
.Should().BeFalse("not contained in list");
}
[Fact]
public void Indexer_Simple()
{
var array = new FlexArrayInt();
array.Add(89);
array[0].Should().Be(89);
}
[Fact]
public void Indexer_Multiple()
{
var array = new FlexArrayInt();
for (var i = 0; i < 100; i++)
{
array.Add(i+1);
}
array[20].Should().Be(21);
array[88].Should().Be(89);
}
[Theory]
[InlineData(-1, "negative index")]
[InlineData(2, "index too high")]
[InlineData(10, "index too high")]
public void Indexer_InvalidIndex(int index, string reason)
{
var array = new FlexArrayInt();
array.Add(-89);
array[index].Should().Be(-1, reason);
}
[Fact]
public void Iterate()
{
var array = new FlexArrayInt();
for (var i = 0; i < 10; i++)
{
array.Add(i);
}
for (var i = 0; i < 10; i++)
{
array[i].Should().Be(i);
}
}
[Fact]
public void Remove_ByIndex_Simple()
{
var array = new FlexArrayInt();
array.Add(40);
array.Count.Should().Be(1);
array.RemoveAt(0).Should().BeTrue("index exists");
array.Count.Should().Be(0, "count has to be reduced");
}
[Fact]
public void Remove_ByIndex_Shifting()
{
var array = new FlexArrayInt();
array.Add(30);
array.Add(31);
array.Add(32);
array.Count.Should().Be(3);
array.RemoveAt(1).Should().BeTrue();
array.Count.Should().Be(2);
array[1].Should().Be(32, "items to the right have to be shifted left after removal");
array.RemoveAt(2)
.Should().BeFalse("not a valid index any longer, despite a value still being there");
}
[Fact]
public void Remove_ByIndex_FromEnd()
{
var array = new FlexArrayInt();
array.Add(30);
array.Add(31);
array.Add(32);
array.Count.Should().Be(3);
array.RemoveAt(2).Should().BeTrue();
array.Count.Should().Be(2);
array[1].Should().Be(31);
}
[Fact]
public void Remove_ByIndex_Invalid()
{
var array = new FlexArrayInt();
array.Add(30);
array.RemoveAt(1)
.Should().BeFalse("the array is big enough for this index, but no value has been set there");
array.Count.Should().Be(1, "unchanged");
array.RemoveAt(-1)
.Should().BeFalse("negative index doesn't make any sense");
}
[Fact]
public void Remove_Single_OneOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(3);
array.Remove(2, true)
.Should().BeTrue("element was found");
array.Count.Should().Be(2, "element was removed");
}
[Fact]
public void Remove_Single_OnlyOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Remove(1, true)
.Should().BeTrue("element was found");
array.Count.Should().Be(0, "element was removed");
}
[Fact] public void Remove_Single_MultipleOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(2);
array.Remove(2, true)
.Should().BeTrue("element was found");
array.Count.Should().Be(2, "only one element was removed");
}
[Fact]
public void Remove_Single_NotFound()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(3);
array.Remove(4, true)
.Should().BeFalse("element was not found");
array.Count.Should().Be(3, "unchanged");
}
[Fact]
public void Remove_Multiple_OneOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(3);
array.Remove(2, false)
.Should().BeTrue("element was found");
array.Count.Should().Be(2, "only one element was removed");
}
[Fact]
public void Remove_Multiple_MultipleOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(2);
array.Add(3);
array.Add(2);
array.Add(4);
array.Add(2);
array.Remove(2, false)
.Should().BeTrue("elements were found");
array.Count.Should().Be(3, "four elements were removed");
}
[Fact]
public void Remove_Multiple_OnlyOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(1);
array.Add(1);
array.Remove(1, false)
.Should().BeTrue("elements were found");
array.Count.Should().Be(0, "all elements were removed");
}
[Fact]
public void Remove_Multiple_NoOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(3);
array.Remove(4, false)
.Should().BeFalse("element was not found");
array.Count.Should().Be(3, "unchanged");
}
}

31
FlexArray.sln Normal file
View file

@ -0,0 +1,31 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.4.33103.184
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FlexArray", "FlexArray\FlexArray.csproj", "{7F30E637-BAFE-42FA-A173-F42B3902ED3B}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FlexArray.Test", "FlexArray.Test\FlexArray.Test.csproj", "{161D9B2A-4E8B-43B6-A77E-40BED559521F}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{7F30E637-BAFE-42FA-A173-F42B3902ED3B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{7F30E637-BAFE-42FA-A173-F42B3902ED3B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{7F30E637-BAFE-42FA-A173-F42B3902ED3B}.Release|Any CPU.ActiveCfg = Release|Any CPU
{7F30E637-BAFE-42FA-A173-F42B3902ED3B}.Release|Any CPU.Build.0 = Release|Any CPU
{161D9B2A-4E8B-43B6-A77E-40BED559521F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{161D9B2A-4E8B-43B6-A77E-40BED559521F}.Debug|Any CPU.Build.0 = Debug|Any CPU
{161D9B2A-4E8B-43B6-A77E-40BED559521F}.Release|Any CPU.ActiveCfg = Release|Any CPU
{161D9B2A-4E8B-43B6-A77E-40BED559521F}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {D322E690-379C-4802-8F7E-1AC6AD090D59}
EndGlobalSection
EndGlobal

View file

@ -0,0 +1,15 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net9.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="HTLLeonding.Utility.LeoAnalyzers" Version="1.0.2" />
</ItemGroup>
</Project>

110
FlexArray/FlexArrayInt.cs Normal file
View file

@ -0,0 +1,110 @@
namespace FlexArray;
public sealed class FlexArrayInt
{
public const int DefaultStartSize = 4;
private int[] _data;
public int Count { get; private set; }
public int Capacity => _data.Length;
public int this[int index]
{
get
{
if (index < 0 || index > Count)
{
return -1;
}
return _data[index];
}
}
public bool Remove(int value, bool firstOnly)
{
var removedAny = false;
for (var i = 0; i < Count; i++)
{
if (value != _data[i])
{
continue;
}
RemoveAt(i--);
removedAny = true;
if (firstOnly)
{
break;
}
}
return removedAny;
}
public bool RemoveAt(int index)
{
if (index < 0 || index >= Count)
{
return false;
}
if (index != Count - 1)
{
ShiftLeft(index);
}
Count--;
return true;
}
private void ShiftLeft(int fromIndex)
{
for (var i = fromIndex; i < Count; i++)
{
_data[i] = _data[i + 1];
}
}
public FlexArrayInt(int? initialSize = null)
{
var size = Math.Max(0, initialSize ?? DefaultStartSize);
_data = new int[size];
}
public void Add(int value)
{
if (Capacity == Count)
{
Grow();
}
_data[Count++] = value;
}
public bool Contains(int value)
{
if (Count == 0)
{
return false;
}
for (var i = 0; i < Count; i++)
{
if (_data[i] == value)
{
return true;
}
}
return false;
}
private void Grow()
{
var newData = new int[Capacity * 2];
Array.Copy(_data, newData, Count);
_data = newData;
}
}

View file

@ -0,0 +1,6 @@
namespace FlexArray;
public class FlexArrayString
{
}

16
FlexArray/Program.cs Normal file
View file

@ -0,0 +1,16 @@
using System.Text;
using FlexArray;
Console.OutputEncoding = Encoding.UTF8;
Console.WriteLine("*** FlexArray ***");
var energyDrinkCans = new FlexArrayInt(2);
Console.WriteLine($"{energyDrinkCans.Count} | {energyDrinkCans.Capacity}");
energyDrinkCans.Add(50);
energyDrinkCans.Add(5);
Console.WriteLine($"{energyDrinkCans.Count} | {energyDrinkCans.Capacity}");
energyDrinkCans.Add(3);
Console.WriteLine($"{energyDrinkCans.Count} | {energyDrinkCans.Capacity}");

599
workshop.adoc Normal file
View file

@ -0,0 +1,599 @@
:icons: font
:source-highlighter: highlightjs
:nofooter:
:sectnums:
= FlexArray -- Live Coding Workshop
Implementation of an ArrayList with automatic growth.
We do it manually at least once before starting to use `List<T>`.
== Project Setup
Create a new project called `FlexArrays` in an _empty_ directory.
[source,shell]
----
// install templates if not done already
// dotnet new install HTLLeonding.Utility.Templates
dotnet new leoconsole -n FlexArrays -o .
----
== Flexible array for `int`
=== Construction
As usual, we start with a test.
.FlexArrayIntTests.cs
[source,csharp]
----
[Fact]
public void Construction_NoSize()
{
var array = new FlexArrayInt();
array.Should().NotBeNull();
array.Count.Should().Be(0, "no items added yet");
array.Capacity.Should().Be(FlexArrayInt.DefaultStartSize, "default capacity");
}
----
To allow the application to compile we need the class `FlexArrayInt`.
.FlexArrayInt.cs
[source,csharp]
----
public sealed class FlexArrayInt
{
public const int DefaultStartSize = 4;
private int[] _data;
public FlexArrayInt(int? initialSize = null) <1>
{
var size = Math.Max(0, initialSize ?? DefaultStartSize); <2>
_data = new int[size];
Count = 0;
}
public int Count { get; private set; } <3>
public int Capacity => _data.Length; <4>
}
----
<1> Providing an initial capacity is optional
<2> Ensuring only valid values are passed
<3> We will adjust that value every time an item is added or removed
<4> The _current_ max. capacity of the list, will change when a _growth_ happens
*Turn on continuous testing now!*
Time for more tests.
.FlexArrayIntTests.cs
[source,csharp]
----
[Theory]
[InlineData(0)]
[InlineData(4)]
[InlineData(20)]
[InlineData(100_000)]
public void Construction_WithSize(int size)
{
var array = new FlexArrayInt(size);
array.Should().NotBeNull();
array.Count.Should().Be(0, "no items added yet");
array.Capacity.Should().Be(size, "initial capacity set to specified size");
}
[Fact]
public void Construction_WithInvalidSize()
{
var array = new FlexArrayInt(-5);
array.Should().NotBeNull();
array.Count.Should().Be(0);
array.Capacity.Should().Be(0, "negative size provided => set to 0");
}
----
=== Adding items
The list has been created, now we need to be able to add elements to it.
.FlexArrayIntTests.cs
[source,csharp]
----
[Fact]
public void AddItem_Single()
{
var array = new FlexArrayInt();
array.Add(17);
array.Count.Should().Be(1, "one item added");
array.Capacity.Should().Be(FlexArrayInt.DefaultStartSize, "capacity unchanged");
}
----
.FlexArrayInt.cs
[source,csharp]
----
public void Add(int value)
{
if (Capacity == Count) <1>
{
Grow(); <1>
}
_data[Count++] = value; <2>
}
private void Grow()
{
// TODO
}
----
<1> If we are out of free space we have to grow
<2> Adding the element to the end of the list
The basic functionality is showing 'green', but does our solution work when adding multiple items?
.FlexArrayIntTests.cs
[source,csharp]
----
[Fact]
public void AddItem_Multiple_NoGrowth()
{
var array = new FlexArrayInt();
array.Add(17);
array.Add(20);
array.Add(-100);
array.Count.Should().Be(3, "three items added");
array.Capacity.Should().Be(FlexArrayInt.DefaultStartSize, "no growth required yet");
}
[Fact]
public void AddItem_Multiple_Growth()
{
var array = new FlexArrayInt();
void AddItems(int count) <1>
{
for (var i = 0; i < count; i++)
{
array.Add(i + 1);
}
}
AddItems(FlexArrayInt.DefaultStartSize);
array.Capacity.Should().Be(FlexArrayInt.DefaultStartSize);
AddItems(2);
array.Capacity.Should().BeGreaterThan(FlexArrayInt.DefaultStartSize, "capacity exceeded, had to grow"); <2>
array.Count.Should().Be(FlexArrayInt.DefaultStartSize + 2);
}
----
<1> Using a local function to reduce code duplication
<2> The list had to grow, but we do not constrain in the test how much it has grown -- that is an implementation detail and up to the list => we (usually) test expected _behaviour_ & _functionality_, not how it is accomplished
The test is 'red' => we haven't implemented growth logic yet.
.FlexArrayInt.cs
[source,csharp]
----
private void Grow()
{
var newData = new int[Capacity * 2]; <1>
Array.Copy(_data, newData, Count); <2>
_data = newData; <3>
}
----
<1> Out growth strategy is to double the size of the array every time -- the more items we add to the list the more space is initially 'wasted'. We could also apply logarithmic scale or a combination; varying scaling factors etc. -- profiling would be required to find a good solution.
<2> Don't forget to copy the data from the old array or the values the user added will be lost
<3> Replacing the reference to the new array -- the old one will be GC'd
=== Contains
Next, we want to check if our list contains a certain element.
.FlexArrayIntTests.cs
[source,csharp]
----
[Fact]
public void Contains_Success()
{
var array = new FlexArrayInt();
array.Add(12);
array.Add(23);
array.Add(-900);
array.Add(76);
array.Contains(23)
.Should().BeTrue();
}
[Fact]
public void Contains_Success_AfterGrowth()
{
var array = new FlexArrayInt();
for (var i = 0; i <= FlexArrayInt.DefaultStartSize; i++)
{
array.Add(i);
}
array.Contains(FlexArrayInt.DefaultStartSize - 1)
.Should().BeTrue();
}
[Fact]
public void Contains_Empty()
{
var array = new FlexArrayInt();
array.Contains(23)
.Should().BeFalse("collection is empty");
}
[Fact]
public void Contains_NotFound()
{
var array = new FlexArrayInt();
array.Add(-12);
array.Add(23);
array.Contains(12)
.Should().BeFalse("not contained in list");
}
----
.FlexArrayInt.cs
[source,csharp]
----
public bool Contains(int value)
{
if (Count == 0)
{
return false;
}
for (var i = 0; i < Count; i++)
{
if (_data[i] == value)
{
return true;
}
}
return false;
}
----
=== Accessing items by index
We want to get items out of the list by index.
This will also allow us to iterate it using a `for` loop.
.FlexArrayIntTests.cs
[source,csharp]
----
[Fact]
public void Indexer_Simple()
{
var array = new FlexArrayInt();
array.Add(89);
array[0].Should().Be(89);
}
[Fact]
public void Indexer_Multiple()
{
var array = new FlexArrayInt();
for (var i = 0; i < 100; i++)
{
array.Add(i+1);
}
array[20].Should().Be(21);
array[88].Should().Be(89);
}
[Theory]
[InlineData(-1, "negative index")]
[InlineData(2, "index too high")]
[InlineData(10, "index too high")]
public void Indexer_InvalidIndex(int index, string reason)
{
var array = new FlexArrayInt();
array.Add(-89);
array[index].Should().Be(-1, reason);
}
[Fact]
public void Iterate()
{
var array = new FlexArrayInt();
for (var i = 0; i < 10; i++)
{
array.Add(i);
}
for (var i = 0; i < 10; i++)
{
array[i].Should().Be(i);
}
}
----
.FlexArrayInt.cs
[source,csharp]
----
public int this[int index]
{
get
{
if (index < 0 || index >= Count)
{
return -1;
}
return _data[index];
}
}
----
=== Removing items
Finally, we need to be able to remove items from the list.
We will provide two options:
. Remove by index
. Remove values
.. First occurrence
.. All occurrences
The critical thing is, that we cannot allow 'gaps' in our backing array, so we'll have to _shift_ remaining values.
This also highlights the primary weakness of an ArrayList.
==== `RemoveAt`
.FlexArrayIntTests.cs
[source,csharp]
----
[Fact]
public void Remove_ByIndex_Simple()
{
var array = new FlexArrayInt();
array.Add(40);
array.Count.Should().Be(1);
array.RemoveAt(0).Should().BeTrue("index exists");
array.Count.Should().Be(0, "count has to be reduced");
}
[Fact]
public void Remove_ByIndex_Shifting()
{
var array = new FlexArrayInt();
array.Add(30);
array.Add(31);
array.Add(32);
array.Count.Should().Be(3);
array.RemoveAt(1).Should().BeTrue();
array.Count.Should().Be(2);
array[1].Should().Be(32, "items to the right have to be shifted left after removal");
array.RemoveAt(2)
.Should().BeFalse("not a valid index any longer, despite a value still being there");
}
[Fact]
public void Remove_ByIndex_FromEnd()
{
var array = new FlexArrayInt();
array.Add(30);
array.Add(31);
array.Add(32);
array.Count.Should().Be(3);
array.RemoveAt(2).Should().BeTrue();
array.Count.Should().Be(2);
array[1].Should().Be(31);
}
[Fact]
public void Remove_ByIndex_Invalid()
{
var array = new FlexArrayInt();
array.Add(30);
array.RemoveAt(1)
.Should().BeFalse("the array is big enough for this index, but no value has been set there");
array.Count.Should().Be(1, "unchanged");
array.RemoveAt(-1)
.Should().BeFalse("negative index doesn't make any sense");
}
----
.FlexArrayInt.cs
[source,csharp]
----
public bool RemoveAt(int index)
{
if (index < 0 || index >= Count)
{
return false;
}
if (index != Count - 1)
{
ShiftLeft(index); <1>
}
Count--;
return true;
}
private void ShiftLeft(int fromIndex)
{
for (var i = fromIndex; i < Count - 1; i++)
{
_data[i] = _data[i + 1]; <2>
}
}
----
<1> If not removing at the end we have to shift to avoid gaps
<2> Why don't we have to set the last index (to the right) to `null`? Didn't we just duplicate a value that is now in the list twice? No, because we reduce the `Count`, so the duplicated value is now 'out of scope'.
==== `Remove`
.FlexArrayIntTests.cs
[source,csharp]
----
[Fact]
public void Remove_Single_OneOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(3);
array.Remove(2, true)
.Should().BeTrue("element was found");
array.Count.Should().Be(2, "element was removed");
}
[Fact]
public void Remove_Single_OnlyOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Remove(1, true)
.Should().BeTrue("element was found");
array.Count.Should().Be(0, "element was removed");
}
[Fact] public void Remove_Single_MultipleOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(2);
array.Remove(2, true)
.Should().BeTrue("element was found");
array.Count.Should().Be(2, "only one element was removed");
}
[Fact]
public void Remove_Single_NotFound()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(3);
array.Remove(4, true)
.Should().BeFalse("element was not found");
array.Count.Should().Be(3, "unchanged");
}
[Fact]
public void Remove_Multiple_OneOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(3);
array.Remove(2, false)
.Should().BeTrue("element was found");
array.Count.Should().Be(2, "only one element was removed");
}
[Fact]
public void Remove_Multiple_MultipleOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(2);
array.Add(3);
array.Add(2);
array.Add(4);
array.Add(2);
array.Remove(2, false)
.Should().BeTrue("elements were found");
array.Count.Should().Be(3, "four elements were removed");
}
[Fact]
public void Remove_Multiple_OnlyOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(1);
array.Add(1);
array.Remove(1, false)
.Should().BeTrue("elements were found");
array.Count.Should().Be(0, "all elements were removed");
}
[Fact]
public void Remove_Multiple_NoOccurrence()
{
var array = new FlexArrayInt();
array.Add(1);
array.Add(2);
array.Add(3);
array.Remove(4, false)
.Should().BeFalse("element was not found");
array.Count.Should().Be(3, "unchanged");
}
----
.FlexArrayInt.cs
[source,csharp]
----
public bool Remove(int value, bool firstOnly)
{
var removedAny = false;
for (var i = 0; i < Count; i++) <3>
{
if (value != _data[i])
{
continue;
}
RemoveAt(i--); <1><2><3>
removedAny = true;
if (firstOnly)
{
break;
}
}
return removedAny;
}
----
<1> Re-use existing functionality whenever possible
<2> Why do we have to decrement the loop index here?
<3> `RemoveAt` will modify `Count` -- but we need `Count` for our loop, why does that work? Could we use a `foreach` loop?
NOTE: Why aren't we shrinking the array again if a sufficient amount of items has been removed?
Because that would require yet another copy operation and 'wasting' some memory is usually more efficient than spending cycles.
What many array list implementation do is to provide a dedicated `Trim` operation, so the user can actively decide when they want to spend the cycles to reduce the memory footprint.
== Flexible array for `string`
Implement the same functionality for `string` instead of `int`.