Added comment to Complex op.

gomlx · Jul 13, 2024 · c7a1e78 · c7a1e78
1 parent 43f29e9
commit c7a1e78
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/xlabuilder/gen_simple_ops.go b/xlabuilder/gen_simple_ops.go
@@ -456,7 +456,7 @@ func Pow(x0, x1 *Op) (*Op, error) {
 	return y, nil
 }
 
-// Complex returns the Op that represents the output of the corresponding operation.
+// Complex returns the complex number taking x0 as the real part and x1 as the imaginary part.
 // The op is created on the same XlaBuilder as used for x0 and x1.
 func Complex(x0, x1 *Op) (*Op, error) {
 	if x0.builder != x1.builder {

diff --git a/xlabuilder/op_types.txt b/xlabuilder/op_types.txt
@@ -127,6 +127,7 @@ Min:two
 // Max returns the element-wise highest value among the two.
 Max:two
 Pow:two
+// Complex returns the complex number taking x0 as the real part and x1 as the imaginary part.
 Complex:two
 
 // Two-arguments comparison ops: