Dotnet/NoiseEngine
Dotnet/NoiseEngine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Renamed repo

Browse Source
This commit is contained in:
Thorsten Sommer 2020-01-12 11:58:08 +01:00
parent df7c9e1235
commit 141b9a65eb
12 changed files with 62 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
NoiseEngine/Contracts/INoiseEngine.cs
View File

@ -2,7 +2,7 @@
using System.Collections.Generic;
using System.Text;
namespace CubicNoise.Contracts
namespace NoiseEngine.Contracts
{
/// <summary>
/// An interface which each noise generator must implement.

2
NoiseEngine/Contracts/IParameterName.cs
View File

@ -1,4 +1,4 @@
namespace CubicNoise.Contracts
namespace NoiseEngine.Contracts
{
/// <summary>
/// An interface which gets used to provide arbitrary parameter names

4
NoiseEngine/EngineParameters.cs
View File

@ -1,9 +1,9 @@
using System;
using System.Collections.Generic;
using System.Text;
using CubicNoise.Contracts;
using NoiseEngine.Contracts;
namespace CubicNoise
namespace NoiseEngine
{
/// <summary>
/// This class stores all parameters needed to create a noise engine instance.

4
NoiseEngine/Extensions.cs
View File

@ -1,9 +1,9 @@
using System;
using System.Collections.Generic;
using System.Text;
using CubicNoise.Noisers;
using NoiseEngine.Noisers;
namespace CubicNoise
namespace NoiseEngine
{
/// <summary>
/// Extension methods for this library.

48
NoiseEngine/NoiseEngine.xml
View File

@ -1,22 +1,22 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>CubicNoise</name>
<name>NoiseEngine</name>
</assembly>
<members>
<member name="T:CubicNoise.Contracts.INoiseEngine">
<member name="T:NoiseEngine.Contracts.INoiseEngine">
<summary>
An interface which each noise generator must implement.
</summary>
</member>
<member name="M:CubicNoise.Contracts.INoiseEngine.Get(System.Single)">
<member name="M:NoiseEngine.Contracts.INoiseEngine.Get(System.Single)">
<summary>
Producing a one-dimensional based noise value.
</summary>
<param name="x">The x coordinate.</param>
<returns>The noise value.</returns>
</member>
<member name="M:CubicNoise.Contracts.INoiseEngine.Get(System.Single,System.Single)">
<member name="M:NoiseEngine.Contracts.INoiseEngine.Get(System.Single,System.Single)">
<summary>
Produces a two-dimensional based noise value.
</summary>
@ -24,7 +24,7 @@
<param name="y">The y coordinate.</param>
<returns>The noise value.</returns>
</member>
<member name="T:CubicNoise.Contracts.IParameterName">
<member name="T:NoiseEngine.Contracts.IParameterName">
<summary>
An interface which gets used to provide arbitrary parameter names
to the general noise engine class. It is a way to abstract the
@ -32,34 +32,34 @@
for different noise generators.
</summary>
</member>
<member name="T:CubicNoise.EngineParameters">
<member name="T:NoiseEngine.EngineParameters">
<summary>
This class stores all parameters needed to create a noise engine instance.
</summary>
</member>
<member name="P:CubicNoise.EngineParameters.Seed">
<member name="P:NoiseEngine.EngineParameters.Seed">
<summary>
The engine's seed value. To use a string value as seed, use the GetDeterministicHashCode() method
which gets provided by this library. A different seed value results in a complete different result.
When you generate e.g. a landscape, two different seeds will produce different landscapes.
</summary>
</member>
<member name="P:CubicNoise.EngineParameters.Type">
<member name="P:NoiseEngine.EngineParameters.Type">
<summary>
The desired kind of noise generator.
</summary>
</member>
<member name="P:CubicNoise.EngineParameters.IntParameters">
<member name="P:NoiseEngine.EngineParameters.IntParameters">
<summary>
A dictionary of additional parameters needed by the chosen noise generator.
</summary>
</member>
<member name="T:CubicNoise.Extensions">
<member name="T:NoiseEngine.Extensions">
<summary>
Extension methods for this library.
</summary>
</member>
<member name="M:CubicNoise.Extensions.GetDeterministicHashCode(System.String)">
<member name="M:NoiseEngine.Extensions.GetDeterministicHashCode(System.String)">
<summary>
This is a deterministic hash function for strings. The official hash methods in .NET Core are no longer
deterministic due to possible hashing attacks, cf. https://youtu.be/R2Cq3CLI6H8.
@ -76,7 +76,7 @@
<param name="str">The string for which a hash value is to be computed.</param>
<returns>A deterministic 32 bit / 4 byte hash value of the given string.</returns>
</member>
<member name="T:CubicNoise.NoiseEngine">
<member name="T:NoiseEngine.NoiseProcessor">
<summary>
The main class of the library. You should use it to generate a noise engine. This class is thread-safe.
You can use all methods from as many threads, as you want. There a no async methods, because the
@ -86,7 +86,7 @@
Not only the factory method is thread-safe. Each instance of the class is thread-safe as well.
</summary>
</member>
<member name="M:CubicNoise.NoiseEngine.Create(CubicNoise.EngineParameters)">
<member name="M:NoiseEngine.NoiseProcessor.Create(NoiseEngine.EngineParameters)">
<summary>
The factory method to use for generating a noise engine. This method is thread-safe. Call it from as many threads
as you want.
@ -94,7 +94,7 @@
<param name="parameters">The parameters for the desired noise engine.</param>
<returns>The desired noise engine instance.</returns>
</member>
<member name="M:CubicNoise.NoiseEngine.Get(System.Single)">
<member name="M:NoiseEngine.NoiseProcessor.Get(System.Single)">
<summary>
Yields a one-dimensional based noise value. This method is thread-safe as well. Call it from as
many threads as you want. You can expect about 16 million calls per CPU core per second (year 2019).
@ -102,7 +102,7 @@
<param name="x">The x coordinate.</param>
<returns>The corresponding noise value for the given coordinate.</returns>
</member>
<member name="M:CubicNoise.NoiseEngine.Get(System.Single,System.Single)">
<member name="M:NoiseEngine.NoiseProcessor.Get(System.Single,System.Single)">
<summary>
Yields a two-dimensional based noise value. This method is thread-safe as well. Call it from as
many threads as you want. You can expect about 6 million calls per CPU core per second (year 2019).
@ -111,7 +111,7 @@
<param name="y">The y coordinate.</param>
<returns>The corresponding noise value for the given 2d coordinate.</returns>
</member>
<member name="T:CubicNoise.Noisers.CubicNoiseEngine">
<member name="T:NoiseEngine.Noisers.CubicNoiseEngine">
<summary>
This is the cubic noise engine by Job Talle, cf. https://jobtalle.com/cubic_noise.html. It based on the
C# version which was provided at Github: https://github.com/jobtalle/CubicNoise/blob/master/c%23/CubicNoise.cs.
@ -122,44 +122,44 @@
used useful C# 8.0 / .NET Core 3.1 LTS features.
</summary>
</member>
<member name="T:CubicNoise.Noisers.CubicNoiseIntParameters">
<member name="T:NoiseEngine.Noisers.CubicNoiseIntParameters">
<summary>
This class contains all known cubic noise's parameters.
</summary>
</member>
<member name="F:CubicNoise.Noisers.CubicNoiseIntParameters.OCTAVE">
<member name="F:NoiseEngine.Noisers.CubicNoiseIntParameters.OCTAVE">
<summary>
Cubic noise's octave parameter.
</summary>
</member>
<member name="F:CubicNoise.Noisers.CubicNoiseIntParameters.PERIOD_X">
<member name="F:NoiseEngine.Noisers.CubicNoiseIntParameters.PERIOD_X">
<summary>
Cubic noise's period x parameter.
</summary>
</member>
<member name="F:CubicNoise.Noisers.CubicNoiseIntParameters.PERIOD_Y">
<member name="F:NoiseEngine.Noisers.CubicNoiseIntParameters.PERIOD_Y">
<summary>
Cubic noise's period y parameter.
</summary>
</member>
<member name="T:CubicNoise.Noisers.RandomNumberEngine">
<member name="T:NoiseEngine.Noisers.RandomNumberEngine">
<summary>
This is the random number engine which gets used in case that the UNKNOWN type was used.
This engine is not meant for production. It is a placeholder for empty values, where a type
is needed. The engine will generate a random value each time.
</summary>
</member>
<member name="T:CubicNoise.NoiseTypes">
<member name="T:NoiseEngine.NoiseTypes">
<summary>
All implemented noise generators.
</summary>
</member>
<member name="F:CubicNoise.NoiseTypes.UNKNOWN">
<member name="F:NoiseEngine.NoiseTypes.UNKNOWN">
<summary>
The UNKNOWN generator is a placeholder for empty values. You should not use it in production. It generates random numbers on every call.
</summary>
</member>
<member name="F:CubicNoise.NoiseTypes.CUBIC_NOISE">
<member name="F:NoiseEngine.NoiseTypes.CUBIC_NOISE">
<summary>
This is the cubic noise generator by Job Talle, cf. https://jobtalle.com/cubic_noise.html and https://github.com/jobtalle.
</summary>

12
NoiseEngine/NoiseEngine.cs → NoiseEngine/NoiseProcessor.cs
View File

@ -1,10 +1,10 @@
using System;
using System.Collections.Generic;
using System.Text;
using CubicNoise.Contracts;
using CubicNoise.Noisers;
using NoiseEngine.Contracts;
using NoiseEngine.Noisers;
namespace CubicNoise
namespace NoiseEngine
{
/// <summary>
/// The main class of the library. You should use it to generate a noise engine. This class is thread-safe.
@ -14,11 +14,11 @@ namespace CubicNoise
///
/// Not only the factory method is thread-safe. Each instance of the class is thread-safe as well.
/// </summary>
public sealed class NoiseEngine : INoiseEngine
public sealed class NoiseProcessor : INoiseEngine
{
private readonly INoiseEngine engine;
private NoiseEngine(NoiseTypes type, int seed, IReadOnlyDictionary<IParameterName, int> intParameters)
private NoiseProcessor(NoiseTypes type, int seed, IReadOnlyDictionary<IParameterName, int> intParameters)
{
this.engine = type switch
{
@ -36,7 +36,7 @@ namespace CubicNoise
/// </summary>
/// <param name="parameters">The parameters for the desired noise engine.</param>
/// <returns>The desired noise engine instance.</returns>
public static NoiseEngine Create(EngineParameters parameters) => new NoiseEngine(parameters.Type, parameters.Seed, parameters?.IntParameters);
public static NoiseProcessor Create(EngineParameters parameters) => new NoiseProcessor(parameters.Type, parameters.Seed, parameters?.IntParameters);
/// <summary>
/// Yields a one-dimensional based noise value. This method is thread-safe as well. Call it from as

2
NoiseEngine/NoiseTypes.cs
View File

@ -2,7 +2,7 @@
using System.Collections.Generic;
using System.Text;
namespace CubicNoise
namespace NoiseEngine
{
/// <summary>
/// All implemented noise generators.

4
NoiseEngine/Noisers/CubicNoiseEngine.cs
View File

@ -2,9 +2,9 @@
using System.Collections.Generic;
using System.Runtime.CompilerServices;
using System.Text;
using CubicNoise.Contracts;
using NoiseEngine.Contracts;
namespace CubicNoise.Noisers
namespace NoiseEngine.Noisers
{
/// <summary>
/// This is the cubic noise engine by Job Talle, cf. https://jobtalle.com/cubic_noise.html. It based on the

4
NoiseEngine/Noisers/CubicNoiseIntParameters.cs
View File

@ -1,9 +1,9 @@
using System;
using System.Collections.Generic;
using System.Text;
using CubicNoise.Contracts;
using NoiseEngine.Contracts;
namespace CubicNoise.Noisers
namespace NoiseEngine.Noisers
{
/// <summary>
/// This class contains all known cubic noise's parameters.

4
NoiseEngine/Noisers/RandomNumberEngine.cs
View File

@ -1,9 +1,9 @@
using System;
using System.Collections.Generic;
using System.Text;
using CubicNoise.Contracts;
using NoiseEngine.Contracts;
namespace CubicNoise.Noisers
namespace NoiseEngine.Noisers
{
/// <summary>
/// This is the random number engine which gets used in case that the UNKNOWN type was used.

22
NoiseEngineTests/CubicNoiseTests.cs
View File

@ -2,19 +2,19 @@
using System.Collections.Generic;
using System.Diagnostics;
using System.Text;
using CubicNoise;
using CubicNoise.Contracts;
using CubicNoise.Noisers;
using NoiseEngine;
using NoiseEngine.Contracts;
using NoiseEngine.Noisers;
using NUnit.Framework;
namespace CubicNoiseTests
namespace NoiseEngineTests
{
public class CubicNoiseTests
public class NoiseEngineTests
{
[Test]
public void TestValidity()
{
var engineO57PX12PY16 = NoiseEngine.Create(new EngineParameters
var engineO57PX12PY16 = NoiseProcessor.Create(new EngineParameters
{
Seed = "test seed".GetDeterministicHashCode(),
Type = NoiseTypes.CUBIC_NOISE,
@ -26,7 +26,7 @@ namespace CubicNoiseTests
},
});
var engineO45PX16PY99 = NoiseEngine.Create(new EngineParameters
var engineO45PX16PY99 = NoiseProcessor.Create(new EngineParameters
{
Seed = "test seed".GetDeterministicHashCode(),
Type = NoiseTypes.CUBIC_NOISE,
@ -113,7 +113,7 @@ namespace CubicNoiseTests
var counter = 0;
var sum = 0L;
var engine = NoiseEngine.Create(new EngineParameters
var engine = NoiseProcessor.Create(new EngineParameters
{
Seed = "test seed".GetHashCode(),
Type = NoiseTypes.CUBIC_NOISE,
@ -154,7 +154,7 @@ namespace CubicNoiseTests
var counter = 0;
var sum = 0L;
var engine = NoiseEngine.Create(new EngineParameters
var engine = NoiseProcessor.Create(new EngineParameters
{
Seed = "test seed".GetHashCode(),
Type = NoiseTypes.CUBIC_NOISE,
@ -195,7 +195,7 @@ namespace CubicNoiseTests
var counter = 0;
var sum = 0L;
var engine = NoiseEngine.Create(new EngineParameters
var engine = NoiseProcessor.Create(new EngineParameters
{
Seed = "test seed".GetHashCode(),
Type = NoiseTypes.CUBIC_NOISE,
@ -235,7 +235,7 @@ namespace CubicNoiseTests
var counter = 0;
var sum = 0L;
var engine = NoiseEngine.Create(new EngineParameters
var engine = NoiseProcessor.Create(new EngineParameters
{
Seed = "test seed".GetHashCode(),
Type = NoiseTypes.CUBIC_NOISE,

16
NoiseEngineTests/NoiseBuilderTests.cs
View File

@ -1,19 +1,19 @@
using System;
using System.Collections.Generic;
using System.Text;
using CubicNoise;
using CubicNoise.Contracts;
using CubicNoise.Noisers;
using NoiseEngine;
using NoiseEngine.Contracts;
using NoiseEngine.Noisers;
using NUnit.Framework;
namespace CubicNoiseTests
namespace NoiseEngineTests
{
public class NoiseBuilderTests
{
[Test]
public void StraightCreation()
{
var engine = NoiseEngine.Create(new EngineParameters
var engine = NoiseProcessor.Create(new EngineParameters
{
Seed = "test seed".GetDeterministicHashCode(),
Type = NoiseTypes.CUBIC_NOISE,
@ -41,7 +41,7 @@ namespace CubicNoiseTests
[Test]
public void NoParameters()
{
var engine = NoiseEngine.Create(new EngineParameters());
var engine = NoiseProcessor.Create(new EngineParameters());
Assert.That(engine, Is.Not.Null);
@ -62,7 +62,7 @@ namespace CubicNoiseTests
{
try
{
var engine = NoiseEngine.Create(null);
var engine = NoiseProcessor.Create(null);
Assert.Fail("Null instead of parameters should not work.");
}
catch
@ -74,7 +74,7 @@ namespace CubicNoiseTests
[Test]
public void PartialParameters()
{
var engine = NoiseEngine.Create(new EngineParameters
var engine = NoiseProcessor.Create(new EngineParameters
{
Seed = "test seed".GetDeterministicHashCode(),
Type = NoiseTypes.CUBIC_NOISE,