GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move hash set related configs into proper header file and rename those

Browse Source
This commit is contained in:
Wojtek Figat
2025-01-24 00:05:07 +01:00
parent 38f74c8cf7
commit dffc6ea24d
3 changed files with 45 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
Source/Engine/Core/Collections/Config.h
View File

@@ -1,27 +0,0 @@
// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
#pragma once
#include "Engine/Platform/Defines.h"
/// <summary>
/// Default capacity for the dictionaries (amount of space for the elements).
/// </summary>
#ifndef DICTIONARY_DEFAULT_CAPACITY
#if PLATFORM_DESKTOP
#define DICTIONARY_DEFAULT_CAPACITY 256
#else
#define DICTIONARY_DEFAULT_CAPACITY 64
#endif
#endif
/// <summary>
/// Default slack space divider for the dictionaries.
/// </summary>
#define DICTIONARY_DEFAULT_SLACK_SCALE 3
/// <summary>
/// Function for dictionary that tells how change hash index during iteration (size param is a buckets table size).
/// </summary>
#define DICTIONARY_PROB_FUNC(size, numChecks) (numChecks)
//#define DICTIONARY_PROB_FUNC(size, numChecks) (1)

42
Source/Engine/Core/Collections/HashSetBase.h
View File

@@ -6,7 +6,35 @@
#include "Engine/Core/Memory/Allocation.h"
#include "Engine/Core/Memory/AllocationUtils.h"
#include "Engine/Core/Collections/HashFunctions.h"
#include "Engine/Core/Collections/Config.h"
/// <summary>
/// Default capacity for the hash set collections (minimum initial amount of space for the elements).
/// </summary>
#ifndef HASH_SET_DEFAULT_CAPACITY
#if PLATFORM_DESKTOP
#define HASH_SET_DEFAULT_CAPACITY 256
#else
#define HASH_SET_DEFAULT_CAPACITY 64
#endif
#endif
/// <summary>
/// Default slack space divider for the hash sets.
/// </summary>
#define HASH_SET_DEFAULT_SLACK_SCALE 3
/// <summary>
/// Function for hash set that tells how change hash index during iteration (size param is a buckets table size).
/// </summary>
#define HASH_SET_PROB_FUNC(size, numChecks) (numChecks)
//#define HASH_SET_PROB_FUNC(size, numChecks) (1)
// [Deprecated in v1.10] Use HASH_SET_DEFAULT_CAPACITY
#define DICTIONARY_DEFAULT_CAPACITY HASH_SET_DEFAULT_CAPACITY
// [Deprecated in v1.10] Use HASH_SET_DEFAULT_SLACK_SCALE
#define DICTIONARY_DEFAULT_SLACK_SCALE HASH_SET_DEFAULT_SLACK_SCALE
// [Deprecated in v1.10] Use HASH_SET_PROB_FUNC
#define DICTIONARY_PROB_FUNC(size, numChecks) (numChecks) HASH_SET_PROB_FUNC(size, numChecks)
/// <summary>
/// Tells if the object is occupied, and if not, if the bucket is a subject of compaction.
@@ -162,12 +190,12 @@ public:
/// <param name="preserveContents">True if preserve collection data when changing its size, otherwise collection after resize will be empty.</param>
void EnsureCapacity(int32 minCapacity, const bool preserveContents = true)
{
minCapacity *= DICTIONARY_DEFAULT_SLACK_SCALE;
minCapacity *= HASH_SET_DEFAULT_SLACK_SCALE;
if (_size >= minCapacity)
return;
int32 capacity = _allocation.CalculateCapacityGrow(_size, minCapacity);
if (capacity < DICTIONARY_DEFAULT_CAPACITY)
capacity = DICTIONARY_DEFAULT_CAPACITY;
if (capacity < HASH_SET_DEFAULT_CAPACITY)
capacity = HASH_SET_DEFAULT_CAPACITY;
SetCapacity(capacity, preserveContents);
}
@@ -324,7 +352,7 @@ protected:
// Move to the next bucket
checksCount++;
bucketIndex = (bucketIndex + DICTIONARY_PROB_FUNC(_size, checksCount)) & tableSizeMinusOne;
bucketIndex = (bucketIndex + HASH_SET_PROB_FUNC(_size, checksCount)) & tableSizeMinusOne;
}
result.ObjectIndex = -1;
result.FreeSlotIndex = insertPos;
@@ -334,11 +362,11 @@ protected:
BucketType* OnAdd(const KeyComparableType& key, bool checkUnique = true)
{
// Check if need to rehash elements (prevent many deleted elements that use too much of capacity)
if (_deletedCount > _size / DICTIONARY_DEFAULT_SLACK_SCALE)
if (_deletedCount > _size / HASH_SET_DEFAULT_SLACK_SCALE)
Compact();
// Ensure to have enough memory for the next item (in case of new element insertion)
EnsureCapacity(((_elementsCount + 1) * DICTIONARY_DEFAULT_SLACK_SCALE + _deletedCount) / DICTIONARY_DEFAULT_SLACK_SCALE);
EnsureCapacity(((_elementsCount + 1) * HASH_SET_DEFAULT_SLACK_SCALE + _deletedCount) / HASH_SET_DEFAULT_SLACK_SCALE);
// Find location of the item or place to insert it
FindPositionResult pos;

20
Source/Engine/Tests/TestCollections.cpp
View File

@@ -185,8 +185,8 @@ TEST_CASE("HashSet")
SECTION("Test Allocators")
{
HashSet<int32> a1;
HashSet<int32, InlinedAllocation<DICTIONARY_DEFAULT_CAPACITY>> a2;
HashSet<int32, FixedAllocation<DICTIONARY_DEFAULT_CAPACITY>> a3;
HashSet<int32, InlinedAllocation<HASH_SET_DEFAULT_CAPACITY>> a2;
HashSet<int32, FixedAllocation<HASH_SET_DEFAULT_CAPACITY>> a3;
for (int32 i = 0; i < 7; i++)
{
a1.Add(i);
@@ -236,7 +236,7 @@ TEST_CASE("HashSet")
{
HashSet<int32> a1;
a1.Add(1);
CHECK(a1.Capacity() <= DICTIONARY_DEFAULT_CAPACITY);
CHECK(a1.Capacity() <= HASH_SET_DEFAULT_CAPACITY);
}
SECTION("Test Add/Remove")
@@ -248,7 +248,7 @@ TEST_CASE("HashSet")
a1.Remove(i);
}
CHECK(a1.Count() == 0);
CHECK(a1.Capacity() <= DICTIONARY_DEFAULT_CAPACITY);
CHECK(a1.Capacity() <= HASH_SET_DEFAULT_CAPACITY);
a1.Clear();
for (int32 i = 1; i <= 10; i++)
a1.Add(-i);
@@ -258,7 +258,7 @@ TEST_CASE("HashSet")
a1.Remove(i);
}
CHECK(a1.Count() == 10);
CHECK(a1.Capacity() <= DICTIONARY_DEFAULT_CAPACITY);
CHECK(a1.Capacity() <= HASH_SET_DEFAULT_CAPACITY);
}
}
@@ -267,8 +267,8 @@ TEST_CASE("Dictionary")
SECTION("Test Allocators")
{
Dictionary<int32, int32> a1;
Dictionary<int32, int32, InlinedAllocation<DICTIONARY_DEFAULT_CAPACITY>> a2;
Dictionary<int32, int32, FixedAllocation<DICTIONARY_DEFAULT_CAPACITY>> a3;
Dictionary<int32, int32, InlinedAllocation<HASH_SET_DEFAULT_CAPACITY>> a2;
Dictionary<int32, int32, FixedAllocation<HASH_SET_DEFAULT_CAPACITY>> a3;
for (int32 i = 0; i < 7; i++)
{
a1.Add(i, i);
@@ -322,7 +322,7 @@ TEST_CASE("Dictionary")
{
Dictionary<int32, int32> a1;
a1.Add(1, 1);
CHECK(a1.Capacity() <= DICTIONARY_DEFAULT_CAPACITY);
CHECK(a1.Capacity() <= HASH_SET_DEFAULT_CAPACITY);
}
SECTION("Test Add/Remove")
@@ -334,7 +334,7 @@ TEST_CASE("Dictionary")
a1.Remove(i);
}
CHECK(a1.Count() == 0);
CHECK(a1.Capacity() <= DICTIONARY_DEFAULT_CAPACITY);
CHECK(a1.Capacity() <= HASH_SET_DEFAULT_CAPACITY);
a1.Clear();
for (int32 i = 1; i <= 10; i++)
a1.Add(-i, -i);
@@ -344,6 +344,6 @@ TEST_CASE("Dictionary")
a1.Remove(i);
}
CHECK(a1.Count() == 10);
CHECK(a1.Capacity() <= DICTIONARY_DEFAULT_CAPACITY);
CHECK(a1.Capacity() <= HASH_SET_DEFAULT_CAPACITY);
}
}