Octoate's Devlog

Math.Round(): Auf oder abrunden?

Mrz 182017

Vor ein paar Tage bin ich an der Arbeit auf ein interessantes Phänomen gestossen, dass mir so bisher noch nicht bewusst war. Wenn man die Math.Round() Methode von .NET verwendet, dann heisst das nicht automatisch, dass bei 1.5 auf 2 und bei 2.5 auf 3 aufgerundet wird. Ein kleines Beispielprogramm zeigt das Verhalten der Math.Round() Methode des .NET Frameworks:

var result = Math.Round(1.5);
Console.WriteLine($"1.5 => {result}");

result = Math.Round(2.5);
Console.WriteLine($"2.5 => {result}");

var result = Math.Round(1.5);

Console.WriteLine($"1.5 => {result}");

result = Math.Round(2.5);

Console.WriteLine($"2.5 => {result}");

Und das Ergebnis:

1.5 => 2
2.5 => 2

1 2	1.5 => 2 2.5 => 2

Komisch, irgendwie haben wir das in der Schule doch mal anders gelernt… Die Antwort ist aber ganz einfach, denn in der MSDN Dokumentation steht unter Math.Round(double):

Rundet einen Gleitkommawert mit doppelter Genauigkeit auf den nächsten ganzzahligen Wert.

Im englischen heisst dieses Verfahren „Bankers Rounding“ und hat den Vorteil, dass bei einer Verteilung von Werten das arithmetische Mittel der gerundeten Zahlen gleich dem arithmetischen Mittel der nicht gerundeten Zahlen ist. Um dennoch das von uns gewüschte Verhalten zu erhalten, ist Math.Round() überladen und man kann zusätzlich noch das MidpointRounding mit angeben. Im folgenden Beispiel sieht man dann das umgestellte Programm:

var result = Math.Round(1.5, MidpointRounding.AwayFromZero);
Console.WriteLine($"1.5 => {result}");

result = Math.Round(2.5, MidpointRounding.AwayFromZero);
Console.WriteLine($"2.5 => {result}");

var result = Math.Round(1.5, MidpointRounding.AwayFromZero);

Console.WriteLine($"1.5 => {result}");

result = Math.Round(2.5, MidpointRounding.AwayFromZero);

Console.WriteLine($"2.5 => {result}");

Ergebnis:

1.5 => 2
2.5 => 3

1 2	1.5 => 2 2.5 => 3

Das Problem ist jetzt nicht riesig, aber dennoch ist es ein Verhalten, dem man sich bewusst sein sollte, wenn man mathematische Berechnungen durchführt. In unseren Anwendungen hat es in wenigen Fällen zu abweichenden Ergebnissen geführt und die Math.Round() Methode hatte dabei niemand auf dem Schirm.

Public Key des ausführenden Prozesses vergleichen

CSharp, Programmierung No Responses »

Jan 182017

Vor einiger Zeit stand ich vor dem Problem, dass ich in einer Assembly feststellen musste, wo ich denn jetzt eigentlich laufe, um davon dann meine Weiterverarbeitung innerhalb der Assembly abhängig zu machen. Das hört sich erst einmal komisch an, lag aber daran, dass ich hier eine komplett autarke Komponente nicht wieder von anderen Assemblies abhängig machen wollte. In diesem Fall gab es dann auch gleich mehrere Möglichkeiten:

innerhalb einer von mir geschriebenen Anwendung
innerhalb einer von einem mir unbekannten Entwickler geschriebenen Anwendung (z.B. Konsole oder Desktop)
innerhalb des Unittest Runners

Die von mir geschriebene Anwendung besitzt natürlich einen Strong Name und zwar genau wie meine unabhängige Assembly. D.h. also, dass ich einfach den Public Key des aufrufenden Prozesses (eigene Anwendung, unbekannte Anwendung, Unittest Runner) mit dem Public Key meiner Assembly vergleichen kann und damit ganz einfach dieses Problem lösen konnte. Über Reflection kommt man auch relativ einfach an die entsprechenden Informationen, die man dafür braucht, heran.
Die folgende Methode ist dabei entstanden und liefert true zurück, wenn der Code der Assembly innerhalb einer von mir signierten Anwendung (Prozess) läuft. In allen anderen Fällen wird ein false zurückgeliefert.

/// <summary>
/// Checks whether the currently running process is signed with my key pair. It compares
/// the public key of the currently running parent process.
/// </summary>
/// <remarks>
/// If this method is used during Unittests, this check will return <c>false</c>, because the
/// Unittest runner process is not signed with my key pair!
/// </remarks>
/// <returns><c>true</c> if the currently running process is signed with my key pair; otherwise <c>false</c>.</returns>
public bool IsSignedProcess()
{
	// get PublicKey from this assembly
	var currentAssemblyName = Assembly.GetAssembly(typeof(Licensing)).GetName();
	var currentPublicKey = currentAssemblyName.GetPublicKey();

	// retrieve the PublicKey from the current process
	var processFileName = Process.GetCurrentProcess().MainModule.FileName;
	var processName = Assembly.ReflectionOnlyLoadFrom(processFileName).GetName();
	var processPublicKey = processName.GetPublicKey();

	return currentPublicKey.SequenceEqual(processPublicKey);
}

/// <summary>

/// Checks whether the currently running process is signed with my key pair. It compares

/// the public key of the currently running parent process.

/// </summary>

/// <remarks>

/// If this method is used during Unittests, this check will return <c>false</c>, because the

/// Unittest runner process is not signed with my key pair!

/// </remarks>

/// <returns><c>true</c> if the currently running process is signed with my key pair; otherwise <c>false</c>.</returns>

public bool IsSignedProcess()

{

// get PublicKey from this assembly

var currentAssemblyName = Assembly.GetAssembly(typeof(Licensing)).GetName();

var currentPublicKey = currentAssemblyName.GetPublicKey();

// retrieve the PublicKey from the current process

var processFileName = Process.GetCurrentProcess().MainModule.FileName;

var processName = Assembly.ReflectionOnlyLoadFrom(processFileName).GetName();

var processPublicKey = processName.GetPublicKey();

return currentPublicKey.SequenceEqual(processPublicKey);

}

Ist eigentlich ganz einfach und funktioniert bei mir ohne Probleme. Den entsprechenden Unittest erspare ich euch hier an dieser Stelle aber einfach einmal. Solltet ihr dennoch daran Interesse haben, dann einfach einen Kommentar hinterlassen und ich trage ihn noch schnell nach :-).

Singletons in C# testen

CSharp, Programmierung No Responses »

Apr 042016

Das Singleton Entwurfsmuster wird in einer Softwarearchitektur verwendet, um sicherzustellen, dass eine Objektinstanz nur einmal erzeugt wird und diese zumeist auch noch global verfügbar ist. Ich verwende es in meinen Entwürfen genau dann, wenn ich dem Anwender die Möglichkeit geben möchte, möglichst einfach auf zentrale Funktionen der zugrundeliegenden Architektur zuzugreifen und diese auch nur einmal vorhanden sein sollen. Es gibt einige Nachteile die man sich dadurch einfängt und eines der Hauptprobleme liegt sicherlich beim Testen. Wie testet man bspw. die Erzeugung des Singletons richtig? Schliesslich wird das Singleton bereits kreiert wenn ich es zum ersten Mal aufrufe und da meine Tests unabhängig voneinander laufen sollen, würden meine nachfolgenden Tests vom bereits kreierten Singleton beeinflusst werden, was ich auf jeden Fall vermeiden möchte.

In unseren Anwendungen verwenden wir immer separate Unittest Assemblies, um die eigentlichen Assemblies mit der Funktionalität zu testen. Die Sichtbarkeit wird über das „InternalsVisibleTo“ Attribut (siehe meinen vorherigen Artikel) für das zu testende Assembly so geändert, dass mit dem „internal“ Modifizierer versehenen Klassen, Methoden, Properties, etc. für das Testassembly sichtbar sind. Im Singleton kann jetzt eine Methode oder ein „set“ eingebaut werden, die das Singleton wieder sauber entfernt.

In der folgenden Klasse habe ich eine „Close()“ Methode implementiert und das „Instance“ Property erweitert. Welche der beiden Wege ihr bevorzugt hängt davon ab, ob weitere Aufräumarbeiten beim Schließen des Singletons notwendig sind (in diesem Fall würde ich eine Methode implementieren) oder ob ein einfaches Setzen des „Instance“ Properties auf „null“ bereits ausreichend ist.

namespace SingletonTest
{
    using System;

    public sealed class AwesomeSingleton
    {
        static AwesomeSingleton singleton;

        static AwesomeSingleton()
        {
            singleton = new AwesomeSingleton();
            Console.WriteLine("Static.");
        }

        private AwesomeSingleton()
        {
            Console.WriteLine("Instantiation.");
        }

        public static AwesomeSingleton Instance
        {
            get
            {
                return singleton;
            }

            internal set
            {
                singleton = value;
            }
        }

        internal void Close()
        {
            singleton = null;
        }
    }
}

namespace SingletonTest

{

using System;

public sealed class AwesomeSingleton

{

static AwesomeSingleton singleton;

static AwesomeSingleton()

{

singleton = new AwesomeSingleton();

Console.WriteLine("Static.");

}

private AwesomeSingleton()

{

Console.WriteLine("Instantiation.");

}

public static AwesomeSingleton Instance

{

get

{

return singleton;

}

internal set

{

singleton = value;

}

internal void Close()

{

singleton = null;

}

Abschließend sei noch zu erwähnen, dass ich es versuche die Modifikation von Quellcode für anschließende Unittests zu vermeiden, da ich der Meinung bin, dass man damit bereits in die Programmlogik eingreift und Fehler verursachen könnte. Die Modifikation des Singletons halte ich deshalb für eine technische Krücke, die man an dieser Stelle leider nicht vermeiden kann. Wie macht ihr das in eurem Code? Ähnlich oder habt ihr eine elegantere Möglichkeit?

Benchmarking von .NET Code

CSharp, Programmierung No Responses »

Mrz 022016

Wir alle bemühen uns performanten und möglichst effizienten Code zu schreiben und auch gegebenenfalls vorhandenen Legacy Code zu verbessern. Um seinen Code zu optimieren gilt die gute alte Regel – messen, messen und nochmal messen, denn nur so kann man die Engpässe vernünftig identifizieren, um danach gezielt eine Lösung zu suchen. Ich arbeite im Normalfall an dieser Stelle mit der guten alten Stopwatch, die man unter System.Diagnostics im .NET Framework findet.

Scott Hanselman hat in seinem Blog aber eine weitere, sehr elegante Möglichkeit vorgestellt, um Methodenaufrufe und Programmteile zu bewerten. Er verwendet dazu die Open Source Bibliothek BenchmarkDotNet, die man natürlich auch als NuGet Package bekommen kann. Fügt man sie einem Projekt hinzu, so kann man mittels dem Attribut Benchmark Methoden markieren, die man genauer betrachten möchte. Über den BenchmarkRunner kann man dann die Klasse mit den Attributen aufrufen.

Am besten sieht man das an einem kleinen Beispiel, das man so auch auf der GitHub Seite von BenchmarkDotNet findet. Die Idee hinter den Beispiel ist es, die Hashverfahren MD5 und SHA256 miteinander zu vergleichen. Wir erstellen also eine einfache Klasse, die ein Array mit Zufallswerten erzeugt und darauf mit dem Aufruf von zwei Methoden, die mit dem Benchmark Attribut markiert werden, sowohl den MD5 als auch den SHA256 laufen lassen:

public class Md5VsSha256
{
	private const int N = 10000;
	private readonly byte[] data;

	private readonly SHA256 sha256 = SHA256.Create();
	private readonly MD5 md5 = MD5.Create();

	public Md5VsSha256()
	{
		this.data = new byte[N];
		new Random(42).NextBytes(this.data);
	}

	[Benchmark]
	public byte[] Sha256()
	{
		return this.sha256.ComputeHash(this.data);
	}

	[Benchmark]
	public byte[] Md5()
	{
		return this.md5.ComputeHash(this.data);
	}
}

public class Md5VsSha256

{

private const int N = 10000;

private readonly byte[] data;

private readonly SHA256 sha256 = SHA256.Create();

private readonly MD5 md5 = MD5.Create();

public Md5VsSha256()

{

this.data = new byte[N];

new Random(42).NextBytes(this.data);

}

[Benchmark]

public byte[] Sha256()

{

return this.sha256.ComputeHash(this.data);

}

[Benchmark]

public byte[] Md5()

{

return this.md5.ComputeHash(this.data);

}

In der Main Methode unserer Anwendung (oder in einem anderen Teil der Anwendung) starten wir dann mit

var summary = BenchmarkRunner.Run<Md5VsSha256>();

1	var summary = BenchmarkRunner.Run<Md5VsSha256>();

den Benchmark. Die Bibliothek führt jetzt den Benchmark auf den Methoden durch und das kann durchaus etwas dauern. Am Ende erhaltet ihr dann eine Zusammenfassung des Benchmarks, die bspw. so aussehen kann:

BenchmarkDotNet=v0.9.1.0
OS=Microsoft Windows NT 6.2.9200.0
Processor=Intel(R) Core(TM) i7-3610QM CPU @ 2.30GHz, ProcessorCount=8
Frequency=2241008 ticks, Resolution=446.2278 ns
HostCLR=MS.NET 4.0.30319.42000, Arch=32-bit RELEASE

Type=Md5VsSha256  Mode=Throughput  

 Method |      Median |    StdDev |
------- |------------ |---------- |
    Md5 |  25.2095 us | 0.2495 us |
 Sha256 | 128.6298 us | 0.6977 us |

BenchmarkDotNet=v0.9.1.0

OS=Microsoft Windows NT 6.2.9200.0

Processor=Intel(R) Core(TM) i7-3610QM CPU @ 2.30GHz, ProcessorCount=8

Frequency=2241008 ticks, Resolution=446.2278 ns

HostCLR=MS.NET 4.0.30319.42000, Arch=32-bit RELEASE

Type=Md5VsSha256 Mode=Throughput

Method | Median | StdDev |

------- |------------ |---------- |

Md5 | 25.2095 us | 0.2495 us |

Sha256 | 128.6298 us | 0.6977 us |

Im bin-Verzeichnis findet ihr außerdem noch wesentlich ausführlichere Ergebnisse des Benchmarks, so unter anderem auch Readme Dateien für die gängigsten Webdienste (bspw. GitHub und StackOverflow), aber auch CSV Dateien, die ihr weiter analysieren könnt. Natürlich kann man noch wesentlich mehr mit der Bibliothek testen (bspw. die unterschiedlichen JIT Varianten, Anzahl der Prozessoren, die .NET Runtime, etc.) oder auch die Ergebnisausgabe an eigene Vorgaben anpassen.
Was verwendet ihr denn so für das Benchmarking von Methoden und Programmteilen? Auch Stopwatch? Die BenchmarkDotNet Bibliothek? Etwas anderes? Würde mich über einen Kommentar von euch freuen :-)!

Goto in C#

CSharp, Programmierung 2 Responses »

Mai 232015

In den letzten Tagen bin ich zum ersten Mal über eine Stelle gestolpert, an der ein „goto“ tatsächlich auch in C# einmal sinnvoll ist. Normalerweise versucht man den Sprung zu irgendwelchen Labeln zu verhindern und in den meisten Fällen braucht man den Befehl auch gar nicht. Allerdings stand ich gerade vor dem Problem, dass ich einen Switch-Case Block so definieren wollte, in dem nach einem Case die darunterliegenden Cases auch ausgeführt werden – also das break nicht notwendig ist. In Java ist das möglich, nicht aber in C#.
Hier ein Beispiel, wie ein solcher Switch-Case Block in Java aussehen könnte:

switch (variable.Length)
{
	case 3:
		variable[2] += 1;
		//weiter mit nächstem Element
	case 2:
		variable[1] += 5;
		//weiter mit nächstem Element
	case 1:
		variable[0] += 9;
		break;
	default:
		throw new IllegalStateException("Something wrong...");
}

switch (variable.Length)

{

case 3:

variable[2] += 1;

//weiter mit nächstem Element

case 2:

variable[1] += 5;

//weiter mit nächstem Element

case 1:

variable[0] += 9;

break;

default:

throw new IllegalStateException("Something wrong...");

}

Das Beispiel ist ganz einfach: Je nach Länge des Arrays wird auf die vorhandenen Elemente irgendeine Operation durchgeführt. In diesem sehr einfachen Beispiel ist das nur eine simple Addition. Lässt man in C# allerdings das break weg, quittiert der Compiler das mit einer Fehlermeldung („Control cannot fall through from one case label (‚case x:‘) to another“). Bleibt also nur Codeduplizierung, oder? Nein, nicht wirklich, denn genau hier kommt das vielgeschmähte goto ins Spiel, da man mit ihm die Labels (inkl. default) innerhalb des Switch-Case Blocks anspringen kann. Damit lässt sich das Beispiel von oben, das in Java funktioniert, ganz einfach auf C# umstellen:

switch (variable.Length)
{
	case 3:
		variable[2] += 1;
		//weiter mit nächstem Element
		goto case 2;
	case 2:
		variable[1] += 5;
		//weiter mit nächstem Element
		goto case 1;
	case 1:
		variable[0] += 9;
		break;
	default:
		throw new InvalidOperationException("Something wrong...");
}

switch (variable.Length)

{

case 3:

variable[2] += 1;

//weiter mit nächstem Element

goto case 2;

case 2:

variable[1] += 5;

//weiter mit nächstem Element

goto case 1;

case 1:

variable[0] += 9;

break;

default:

throw new InvalidOperationException("Something wrong...");

}

Eine recht einfache Lösung, oder? Bisher kannte ich diese Vorgehensweise noch nicht, aber man lernt ja nie aus :).

Older Entries