StructPerformance

Wenn man in C# mit Structs arbeitet gibt es vor allem im Hinblick auf die Performance ein paar Aspekte die man beachten sollte. Dieser Artikel zeigt die Unterschiede in der Verwendung von Structs und worauf man achten muss.

Call by Value

Bei C# geschehen Parameterübergaben bei Funktionsaufrufen (genauso wie bei Java) implizit immer in Form von "call by value". Das heisst dass übergebene Variablen für die Verwendung in Methoden kopiert werden.

Hier ist ein Codebeispiel dazu:

public class Test
{
  public int number;

  public Test(int number)
  {
    this.number = number;
  }
}

public class MyApp
{
  public static void Main()
  {
    Test test = new Test(7);
    ChangeNumber1(test);
    System.Console.WriteLine(test.number);  // gibt 7 aus
    ChangeNumber2(test);
    System.Console.WriteLine(test.number);  // gibt 4 aus
  }

  public void ChangeNumber1(Test test)
  {
    test = new Test(3);
  }
  public void ChangeNumber2(Test test)
  {
    test.number = 4;
  }
}

Warum ändert die Methode ChangeNumber1 nun bei der Ausgabe die Zahl nicht? Zur kurzen Wiederholung: Dieses Codebeispiel verwendet Klassen und Klassen sind reference types. Beim Aufruf der Methode wird also nicht direkt die Instanz der Klasse übergeben sondern nur eine Referenz, also ein Hinweis wo sich die Instanz der dahinterliegenden Klasse befindet. Da Parameter implizit mit call by value übergeben werden, also für die Methode kopiert werden, erhält die Methode quasi eine neue Referenz, welche lediglich auf die selbe Instanz der Klasse verweist wie die ursprüngliche Referenz die beim Methodenaufruf verwendet wurde. Innerhalb der Methode wird die neue Referenz dann auf eine andere Instanz der Klasse Test geändert. Beim Verlassen der Methode wird die Referenz dann automatisch gelöscht, die neue Instanz der Klasse Test mit dem Wert 3 damit also auch da sie nichtmehr referenziert wird.

Die Methode ChangeNumber2 greift dagegen über die kopierte Referenz auf die selbe Klasseninstanz zurück, auf die die ursprüngliche Referenz ebenfalls verweist. Daher wird hier der Zahlenwert geändert und anschließend auch entsprechend ausgegeben.

Das selbe Prinzip gilt ähnlich auch für Structs. Da Structs allerdings value types sind, wird beim Übergeben einer Struct als Parameter nicht nur eine Referenz, sondern der komplette Inhalt der Struct kopiert! Dies kann je nach Inhalt der Struct (z.B. 16 float Werte bei einer Matrix-Struct) relativ lange dauern und damit die Performance des Spiels massiv verschlechtern wenn Structs sehr häufig als Parameter übergeben werden! Das obige Beispiel für Klassen funktioniert mit Structs daher nichtmehr:

public class MyApp
{
  public static void Main()
  {
    Vector3 test = new Vector3(7.0f);
    ChangeVector1(test);
    System.Console.WriteLine(test);  // gibt {X:7 Y:7 Z:7} aus
    ChangeVector2(test);
    System.Console.WriteLine(test);  // gibt auch {X:7 Y:7 Z:7} aus
  }

  public void ChangeVector1(Vector3 vector)
  {
    vector = new Vector3(3.0);
  }
  public void ChangeVector2(Vector3 vector)
  {
    vector.x = 4.0;
    vector.y = 4.0;
    vector.z = 4.0;
  }
}

Call by value gilt auch für einfache Zuweisungen:

//Klassen
Test class1 = new Test(2);
Test class2 = class1; //class2 ist jetzt eine kopierte Referenz, die auf die selbe Instanz von Test zeigt wie class1
System.Console.WriteLine(class1.number); //gibt 2 aus
System.Console.WriteLine(class2.number); //gibt 2 aus
class2.number = 4;
System.Console.WriteLine(class1.number); //gibt 4 aus
System.Console.WriteLine(class2.number); //gibt 4 aus
class2 = new Test(7); //Die Referenz class2 zeigt jetzt auf eine neue Instanz der Klasse Test
System.Console.WriteLine(class1.number); //gibt 4 aus
System.Console.WriteLine(class2.number); //gibt 7 aus

//Structs
Vector3 struct1 = new Vector3(2.0f);
Vector3 struct2 = struct1; //struct2 ist jetzt eine neue Struct mit den selben Werten wie struct1
System.Console.WriteLine(struct1); //gibt {X:2 Y:2 Z:2} aus
System.Console.WriteLine(struct2); //gibt {X:2 Y:2 Z:2} aus
struct2.x = 4.0f;
System.Console.WriteLine(struct1); //gibt {X:2 Y:2 Z:2} aus
System.Console.WriteLine(struct2); //gibt {X:4 Y:2 Z:2} aus

Call by Reference

Implizit gilt bei C# also call by value für Parameterübergaben, es kann allerdings auch explizit ein call by reference erzwungen werden. Dazu gibt es das Schlüsselwort ref, welches vor die Parameter einer Methode geschrieben werden kann. Dies hat dann zur Folge dass keine Kopie, sondern direkt die Referenz auf die entsprechende Klasse oder Struct übergeben wird. Schauen wir uns die call by value Code-Beispiele mit der Verwendung von call by reference an:

public class Test
{
  public int number;

  public Test(int number)
  {
    this.number = number;
  }
}

public class MyApp
{
  public static void Main()
  {
    Test test = new Test(7);
    ChangeNumber1(ref test);
    System.Console.WriteLine(test.number);  // gibt 3 aus
    ChangeNumber2(ref test);
    System.Console.WriteLine(test.number);  // gibt 4 aus
  }

  public void ChangeNumber1(ref Test test)
  {
    test = new Test(3);
  }
  public void ChangeNumber2(ref Test test)
  {
    test.number = 4;
  }
}

public class MyApp
{
  public static void Main()
  {
    Vector3 test = new Vector3(7.0f);
    ChangeVector1(ref test);
    System.Console.WriteLine(test);  // gibt {X:3 Y:3 Z:3} aus
    ChangeVector2(ref test);
    System.Console.WriteLine(test);  // gibt auch {X:4 Y:4 Z:4} aus
  }

  public void ChangeVector1(ref Vector3 vector)
  {
    vector = new Vector3(3.0);
  }
  public void ChangeVector2(ref Vector3 vector)
  {
    vector.x = 4.0;
    vector.y = 4.0;
    vector.z = 4.0;
  }
}

Call by reference funktioniert für Structs genauso wie für Klassen. Structs lassen sich somit effizienter übergeben, da keine kompletten Kopien mehr erstellt werden müssen. Allerdings muss man aufpassen dass man beim Ändern einer so übergebenen Struct direkt das ursprüngliche Objekt ändert, was standardmäßig nicht der Fall ist.

Gerade an Codestellen die häufig durchlaufen werden empfielt es sich im Hinblick auf die Performance das call by reference zu nutzen. Die häufig verwendeten Structs wie z.B. die Vector3-Struct verfügen selber bereits über entsprechende statische Methoden für verschiedene Rechenoperationen wie z.B.:

void Vector3.Add(ref Vector3 value1, ref Vector3 value2, out Vector3 result);
void Vector3.Multiply(ref Vector3 value1, float scaleFactor, out Vector3 result);
...

Diese sind wesentlich Effizienter wie ihre Pendants mit call by value:

Vector3 sum = Vector3.Add(Vector3 value1, Vector2 value2);
Vector3 scaledVec = Vector3.Multiply(Vector3 value1, float scaleFactor);
...
Vector3 sum = vector1 + vector2;
Vector3 scaledVec = vector1 * scaleFactor;
...

Das out Schlüsselwort das in den Beispielmethoden ebenfalls verwendet wird dient zum deklarieren von Rückgabeparametern. Diese werden im nächsten Abschnitt erläutert.

Rückgabeparameter

Da die Rückgabewerte von Methoden einer Variablen zugewiesen werden müssen gilt auch für diese call by value, also dass sie kopiert werden. Zudem kann nur ein Wert von einer Methode zurückgegeben werden. Um dies umgehen zu können gibt es bei C# zusätzlich zu ref auch noch das Schlüsselwort out für Parameter. Dieses dient zur Deklaration von Rückgabeparametern. Damit ist es nicht nur möglich neben der Parameterübergabe auch die Werterückgabe performanter zu gestalten sondern zusätzlich können auch beliebig viele Werte von einer Funktion zurückgegeben werden, ohne dass eine spezielle Klasse zur Datenhaltung oder ähnliches benötigt wird.

Theoretisch können auch Parameter die mit ref übergeben werden zur Rückgabe von Werten verwendet werden. Der Unterschied zu out Parametern ist allerdings der, dass ref Parameter im Voraus immer initialisiert sein müssen während out Parameter auch ohne Initialisierung übergeben werden können.

Verwendung von Structs

Zu der Frage wann denn nun Structs und wann Klassen verwendet werden sollten gibt es einen kurzen MSDN-Artikel: Using Structs