aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar David Tellenbach <david.tellenbach@me.com>2020-10-14 01:56:42 +0000
committerGravatar David Tellenbach <david.tellenbach@me.com>2020-10-14 01:56:42 +0000
commite3e2cf9d243e9dc59531240690e66c89f49d418e (patch)
tree71af97e7e7f9e350fb643588404d35e158ab1888 /doc
parent61fc78bbda22f425a97761be57c219928d929ddc (diff)
Add MatrixBase::cwiseArg()
Diffstat (limited to 'doc')
-rw-r--r--doc/CoeffwiseMathFunctionsTable.dox14
-rw-r--r--doc/snippets/MatrixBase_cwiseArg.cpp3
2 files changed, 17 insertions, 0 deletions
diff --git a/doc/CoeffwiseMathFunctionsTable.dox b/doc/CoeffwiseMathFunctionsTable.dox
index d6ad06f3a..3f5c56446 100644
--- a/doc/CoeffwiseMathFunctionsTable.dox
+++ b/doc/CoeffwiseMathFunctionsTable.dox
@@ -74,6 +74,20 @@ This also means that, unless specified, if the function \c std::foo is available
<td>All engines (fc,fd)</td>
</tr>
<tr>
+ <td class="code">
+ \anchor cwisetable_arg
+ a.\link ArrayBase::arg arg\endlink(); \n
+ \link Eigen::arg arg\endlink(a); \n
+ m.\link MatrixBase::cwiseArg cwiseArg\endlink();
+ </td>
+ <td>phase angle of complex number</td>
+ <td class="code">
+ using <a href="http://en.cppreference.com/w/cpp/numeric/complex/arg">std::arg</a>; \n
+ arg(a[i]);
+ </td>
+ <td>All engines (fc,fd)</td>
+</tr>
+<tr>
<th colspan="4">Exponential functions</th>
</tr>
<tr>
diff --git a/doc/snippets/MatrixBase_cwiseArg.cpp b/doc/snippets/MatrixBase_cwiseArg.cpp
new file mode 100644
index 000000000..e0857cf97
--- /dev/null
+++ b/doc/snippets/MatrixBase_cwiseArg.cpp
@@ -0,0 +1,3 @@
+MatrixXcf v = MatrixXcf::Random(2, 3);
+cout << v << endl << endl;
+cout << v.cwiseArg() << endl; \ No newline at end of file