Documented complex object, fix some errors in math documentation.

Author: trypsynth

doc/src/references/builtin/Math/Classes/complex/Functions/abs.nvgt

@@ -0,0 +1,10 @@
+/**
+	Returns the absolute value (magnitude) of the complex number.
+	float complex::abs() const;
+*/
+
+// Example:
+void main() {
+	complex c(3, 4);
+	alert("Magnitude =", c.abs());
+}

doc/src/references/builtin/Math/Classes/complex/Operators/opAdd.nvgt

@@ -0,0 +1,21 @@
+/**
+	Adds two complex numbers and returns the result.
+	complex complex::opAdd(const complex&in other) const;
+	## Arguments:
+		* const complex&in other: the complex number to add.
+	## Returns:
+		complex: a new complex object containing the value of the addition.
+*/
+
+// Example:
+// Helper function to print a complex number.
+string to_string(const complex&in c) {
+	return "(" + c.r + ", " + c.i + ")";
+}
+
+void main() {
+	complex a(1, 2);
+	complex b(3, 4);
+	complex c = a + b;
+	alert("a + b =", to_string(c));
+}

doc/src/references/builtin/Math/Classes/complex/Operators/opAddAssign.nvgt

@@ -0,0 +1,21 @@
+/**
+	Adds another complex number to this one.
+	complex& complex::opAddAssign(const complex&in other);
+	## Arguments:
+		* const complex&in other: the complex number to add.
+	## Returns:
+		complex&: a reference to the complex number being operated on.
+*/
+
+// Example:
+// Helper function to print a complex number.
+string to_string(const complex&in c) {
+	return "(" + c.r + ", " + c.i + ")";
+}
+
+void main() {
+	complex a(1, 2);
+	complex b(3, 4);
+	a += b;
+	alert("a + b =", to_string(a));
+}

doc/src/references/builtin/Math/Classes/complex/Operators/opDiv.nvgt

@@ -0,0 +1,21 @@
+/**
+	Divides this complex number by another and returns the result.
+	complex complex::opDiv(const complex&in other) const;
+	## Arguments:
+		* const complex&in other: the complex number to divide by.
+	## Returns:
+		complex: a new complex object containing the value of the division.
+*/
+
+// Example:
+// Helper function to print a complex number.
+string to_string(const complex&in c) {
+	return "(" + c.r + ", " + c.i + ")";
+}
+
+void main() {
+	complex a(1, 2);
+	complex b(3, 4);
+	complex c = a / b;
+	alert("a / b =", to_string(c));
+}

doc/src/references/builtin/Math/Classes/complex/Operators/opDivAssign.nvgt

@@ -0,0 +1,21 @@
+/**
+	Divides this complex number by another.
+	complex& complex::opDivAssign(const complex&in other);
+	## Arguments:
+		* const complex&in other: the complex number to divide by.
+	## Returns:
+		complex&: a reference to the complex number being operated on.
+*/
+
+// Example:
+// Helper function to print a complex number.
+string to_string(const complex&in c) {
+	return "(" + c.r + ", " + c.i + ")";
+}
+
+void main() {
+	complex a(1, 2);
+	complex b(3, 4);
+	a /= b;
+	alert("a / b =", to_string(a));
+}

doc/src/references/builtin/Math/Classes/complex/Operators/opEquals.nvgt

@@ -0,0 +1,15 @@
+/**
+	Checks if two complex numbers are equal.
+	bool complex::opEquals(const complex&in other) const;
+	## Arguments:
+		* const complex&in other: the complex number to compare to.
+	## Returns:
+		bool: true if the two complex numbers are equal, false otherwise.
+*/
+
+// Example:
+void main() {
+	complex a(1, 2);
+	complex b(1, 2);
+	alert("a equals b?", a == b);
+}

doc/src/references/builtin/Math/Classes/complex/Operators/opMul.nvgt

@@ -0,0 +1,21 @@
+/**
+	Multiplies two complex numbers and returns the result.
+	complex complex::opMul(const complex&in other) const;
+	## Arguments:
+		* const complex&in other: the complex number to multiply with.
+	## Returns:
+		complex: a new complex object containing the value of the multiplication.
+*/
+
+// Example:
+// Helper function to print a complex number.
+string to_string(const complex&in c) {
+	return "(" + c.r + ", " + c.i + ")";
+}
+
+void main() {
+	complex a(1, 2);
+	complex b(3, 4);
+	complex c = a * b;
+	alert("a * b =", to_string(c));
+}

doc/src/references/builtin/Math/Classes/complex/Operators/opMulAssign.nvgt

@@ -0,0 +1,21 @@
+/**
+	Multiplies this complex number by another.
+	complex& complex::opMulAssign(const complex&in other);
+	## Arguments:
+		* const complex&in other: the complex number to multiply with.
+	## Returns:
+		complex&: a reference to the complex number being operated on.
+*/
+
+// Example:
+// Helper function to print a complex number.
+string to_string(const complex&in c) {
+	return "(" + c.r + ", " + c.i + ")";
+}
+
+void main() {
+	complex a(1, 2);
+	complex b(3, 4);
+	a *= b;
+	alert("a * b =", to_string(a));
+}

doc/src/references/builtin/Math/Classes/complex/Operators/opSub.nvgt

@@ -0,0 +1,21 @@
+/**
+	Subtracts a complex number from this one and returns the result.
+	complex complex::opSub(const complex&in other) const;
+	## Arguments:
+		* const complex&in other: the complex number to subtract.
+	## Returns:
+		complex: a new complex object containing the value of the subtraction.
+*/
+
+// Example:
+// Helper function to print a complex number.
+string to_string(const complex&in c) {
+	return "(" + c.r + ", " + c.i + ")";
+}
+
+void main() {
+	complex a(5, 6);
+	complex b(2, 3);
+	complex c = a - b;
+	alert("a - b =", to_string(c));
+}

doc/src/references/builtin/Math/Classes/complex/Operators/opSubAssign.nvgt

@@ -0,0 +1,21 @@
+/**
+	Subtracts another complex number from this one.
+	complex& complex::opSubAssign(const complex&in other);
+	## Arguments:
+		* const complex&in other: the complex number to subtract.
+	## Returns:
+		complex&: a reference to the complex number being operated on.
+*/
+
+// Example:
+// Helper function to print a complex number.
+string to_string(const complex&in c) {
+	return "(" + c.r + ", " + c.i + ")";
+}
+
+void main() {
+	complex a(5, 6);
+	complex b(2, 3);
+	a -= b;
+	alert("a - b =", to_string(a));
+}