pmlpp/doc_classes/MLPPMatrix.xml

784 lines
21 KiB
XML
Raw Permalink Normal View History

2023-02-12 19:17:06 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MLPPMatrix" inherits="Reference" version="3.11">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
2023-04-25 20:32:54 +02:00
<method name="abs">
<return type="void" />
<description>
</description>
</method>
<method name="absb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="absn" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="add">
<return type="void" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_add">
2023-02-12 19:17:06 +01:00
<return type="void" />
<argument index="0" name="row" type="PoolRealArray" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_add_mlpp_vector">
2023-02-12 19:17:06 +01:00
<return type="void" />
<argument index="0" name="row" type="MLPPVector" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="rows_add_mlpp_matrix">
2023-02-12 19:17:06 +01:00
<return type="void" />
<argument index="0" name="other" type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="add_vec">
<return type="void" />
<argument index="0" name="b" type="MLPPVector" />
<description>
</description>
</method>
<method name="add_vecb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="b" type="MLPPVector" />
<description>
</description>
</method>
<method name="add_vecn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="b" type="MLPPVector" />
<description>
</description>
</method>
<method name="addb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="addn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="adjoint" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="adjointo" qualifiers="const">
<return type="void" />
<argument index="0" name="out" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="cbrt">
<return type="void" />
<description>
</description>
</method>
<method name="cbrtb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="cbrtn" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
<method name="clear">
<return type="void" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="cofactor" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="n" type="int" />
<argument index="1" name="i" type="int" />
<argument index="2" name="j" type="int" />
<description>
</description>
</method>
<method name="cofactoro" qualifiers="const">
<return type="void" />
<argument index="0" name="n" type="int" />
<argument index="1" name="i" type="int" />
<argument index="2" name="j" type="int" />
<argument index="3" name="out" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="cos">
<return type="void" />
<description>
</description>
</method>
<method name="cosb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="cosn" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="cov" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="covo" qualifiers="const">
<return type="void" />
<argument index="0" name="out" type="MLPPMatrix" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
<method name="data_size" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="det" qualifiers="const">
<return type="float" />
<argument index="0" name="d" type="int" default="-1" />
<description>
</description>
</method>
<method name="detb" qualifiers="const">
<return type="float" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="d" type="int" />
<description>
</description>
</method>
<method name="diagonal_zeroed">
<return type="void" />
<argument index="0" name="a" type="MLPPVector" />
<description>
</description>
</method>
<method name="diagonal_zeroedn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="a" type="MLPPVector" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
<method name="duplicate" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="eigen">
<return type="Array" />
<description>
</description>
</method>
<method name="eigenb">
<return type="Array" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-29 13:50:35 +02:00
<method name="division_element_wise">
2023-04-25 20:32:54 +02:00
<return type="void" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-29 13:50:35 +02:00
<method name="division_element_wiseb">
2023-04-25 20:32:54 +02:00
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-29 13:50:35 +02:00
<method name="division_element_wisen" qualifiers="const">
2023-04-25 20:32:54 +02:00
<return type="MLPPMatrix" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
<method name="empty" qualifiers="const">
<return type="bool" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="erf">
<return type="void" />
<description>
</description>
</method>
<method name="erfb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="erfn" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="exp">
<return type="void" />
<description>
</description>
</method>
<method name="expb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="expn" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="exponentiate">
<return type="void" />
<argument index="0" name="p" type="float" />
<description>
</description>
</method>
<method name="exponentiateb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="p" type="float" />
<description>
</description>
</method>
<method name="exponentiaten" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="p" type="float" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
<method name="fill">
<return type="void" />
<argument index="0" name="val" type="float" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="flatten" qualifiers="const">
<return type="MLPPVector" />
<description>
</description>
</method>
<method name="flatteno" qualifiers="const">
<return type="void" />
<argument index="0" name="out" type="MLPPVector" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="matn_full" qualifiers="const">
2023-04-25 20:32:54 +02:00
<return type="MLPPMatrix" />
<argument index="0" name="n" type="int" />
<argument index="1" name="m" type="int" />
<argument index="2" name="k" type="int" />
<description>
</description>
</method>
<method name="gaussian_noise" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="n" type="int" />
<argument index="1" name="m" type="int" />
<description>
</description>
</method>
<method name="gaussian_noise_fill">
<return type="void" />
<description>
</description>
</method>
<method name="get_as_image" qualifiers="const">
<return type="Image" />
<description>
</description>
</method>
<method name="element_get" qualifiers="const">
2023-02-12 19:17:06 +01:00
<return type="float" />
2023-04-25 20:32:54 +02:00
<argument index="0" name="index_y" type="int" />
<argument index="1" name="index_x" type="int" />
<description>
</description>
</method>
<method name="element_get_index" qualifiers="const">
2023-04-25 20:32:54 +02:00
<return type="float" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="get_into_image" qualifiers="const">
<return type="void" />
<argument index="0" name="out" type="Image" />
2023-02-12 19:17:06 +01:00
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_get_into_mlpp_vector" qualifiers="const">
2023-02-12 19:17:06 +01:00
<return type="void" />
<argument index="0" name="index_y" type="int" />
<argument index="1" name="target" type="MLPPVector" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_get_mlpp_vector" qualifiers="const">
2023-02-12 19:17:06 +01:00
<return type="MLPPVector" />
<argument index="0" name="index_y" type="int" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_get_pool_vector" qualifiers="const">
2023-02-12 19:17:06 +01:00
<return type="PoolRealArray" />
<argument index="0" name="index_y" type="int" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="hadamard_product">
<return type="void" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="hadamard_productb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="hadamard_productn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="identity">
<return type="void" />
<description>
</description>
</method>
<method name="identity_mat" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="d" type="int" />
<description>
</description>
</method>
<method name="identityn" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="inverse" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="inverseo" qualifiers="const">
<return type="void" />
<argument index="0" name="out" type="MLPPMatrix" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
<method name="is_equal_approx" qualifiers="const">
<return type="bool" />
<argument index="0" name="with" type="MLPPMatrix" />
<argument index="1" name="tolerance" type="float" default="1e-05" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="kronecker_product">
<return type="void" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="kronecker_productb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="kronecker_productn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="log">
<return type="void" />
<description>
</description>
</method>
<method name="log10">
<return type="void" />
<description>
</description>
</method>
<method name="log10b">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="log10n" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="logb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="logn" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="max">
<return type="void" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="maxb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="maxn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="mult">
<return type="void" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="mult_vec" qualifiers="const">
<return type="MLPPVector" />
<argument index="0" name="b" type="MLPPVector" />
<description>
</description>
</method>
<method name="mult_veco">
<return type="void" />
<argument index="0" name="b" type="MLPPVector" />
<argument index="1" name="out" type="MLPPVector" />
<description>
</description>
</method>
<method name="multb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="multn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="matn_one" qualifiers="const">
2023-04-25 20:32:54 +02:00
<return type="MLPPMatrix" />
<argument index="0" name="n" type="int" />
<argument index="1" name="m" type="int" />
<description>
</description>
</method>
<method name="outer_product">
<return type="void" />
<argument index="0" name="a" type="MLPPVector" />
<argument index="1" name="b" type="MLPPVector" />
<description>
</description>
</method>
<method name="outer_productn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="a" type="MLPPVector" />
<argument index="1" name="b" type="MLPPVector" />
<description>
</description>
</method>
<method name="pinverse" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="pinverseo" qualifiers="const">
<return type="void" />
<argument index="0" name="out" type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_remove">
2023-02-12 19:17:06 +01:00
<return type="void" />
2023-04-25 20:32:54 +02:00
<argument index="0" name="index" type="int" />
2023-02-12 19:17:06 +01:00
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_remove_unordered">
2023-02-12 19:17:06 +01:00
<return type="void" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="reset">
<return type="void" />
<description>
</description>
</method>
<method name="resize">
<return type="void" />
<argument index="0" name="size" type="Vector2i" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="scalar_add">
<return type="void" />
<argument index="0" name="scalar" type="float" />
<description>
</description>
</method>
<method name="scalar_addb">
<return type="void" />
<argument index="0" name="scalar" type="float" />
<argument index="1" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="scalar_addn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="scalar" type="float" />
<description>
</description>
</method>
<method name="scalar_multiply">
<return type="void" />
<argument index="0" name="scalar" type="float" />
<description>
</description>
</method>
<method name="scalar_multiplyb">
<return type="void" />
<argument index="0" name="scalar" type="float" />
<argument index="1" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="scalar_multiplyn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="scalar" type="float" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="diagonal_set">
2023-04-25 20:32:54 +02:00
<return type="void" />
<argument index="0" name="a" type="MLPPVector" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="diagonal_setn" qualifiers="const">
2023-04-25 20:32:54 +02:00
<return type="MLPPMatrix" />
<argument index="0" name="a" type="MLPPVector" />
<description>
</description>
</method>
<method name="element_set">
2023-02-12 19:17:06 +01:00
<return type="void" />
2023-04-25 20:32:54 +02:00
<argument index="0" name="index_y" type="int" />
<argument index="1" name="index_x" type="int" />
2023-02-12 19:17:06 +01:00
<argument index="2" name="val" type="float" />
<description>
</description>
</method>
<method name="element_set_index">
2023-04-25 20:32:54 +02:00
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="val" type="float" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
<method name="set_from_arrays">
<return type="void" />
<argument index="0" name="from" type="Array" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="set_from_image">
<return type="void" />
<argument index="0" name="img" type="Image" />
<argument index="1" name="image_channel" type="int" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
<method name="set_from_mlpp_matrix">
<return type="void" />
<argument index="0" name="from" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="set_from_mlpp_vectors_array">
<return type="void" />
<argument index="0" name="from" type="Array" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_set_mlpp_vector">
2023-02-12 19:17:06 +01:00
<return type="void" />
<argument index="0" name="index_y" type="int" />
<argument index="1" name="row" type="MLPPVector" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_set_pool_vector">
2023-02-12 19:17:06 +01:00
<return type="void" />
<argument index="0" name="index_y" type="int" />
<argument index="1" name="row" type="PoolRealArray" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="sin">
<return type="void" />
<description>
</description>
</method>
<method name="sinb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="sinn" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
<method name="size" qualifiers="const">
<return type="Vector2i" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="sqrt">
<return type="void" />
<description>
</description>
</method>
<method name="sqrtb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="sqrtn" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
<method name="sub">
<return type="void" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="subb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<argument index="1" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="subn" qualifiers="const">
<return type="MLPPMatrix" />
<argument index="0" name="B" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="svd">
<return type="Array" />
<description>
</description>
</method>
<method name="svdb">
<return type="Array" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="row_swap">
2023-02-12 19:17:06 +01:00
<return type="void" />
<argument index="0" name="index_1" type="int" />
<argument index="1" name="index_2" type="int" />
<description>
</description>
</method>
<method name="to_flat_byte_array" qualifiers="const">
<return type="PoolByteArray" />
<description>
</description>
</method>
<method name="to_flat_pool_vector" qualifiers="const">
<return type="PoolRealArray" />
<description>
</description>
</method>
2023-04-25 20:32:54 +02:00
<method name="transpose">
<return type="void" />
<description>
</description>
</method>
<method name="transposeb">
<return type="void" />
<argument index="0" name="A" type="MLPPMatrix" />
<description>
</description>
</method>
<method name="transposen" qualifiers="const">
<return type="MLPPMatrix" />
<description>
</description>
</method>
2023-04-29 15:07:30 +02:00
<method name="matn_zero" qualifiers="const">
2023-04-25 20:32:54 +02:00
<return type="MLPPMatrix" />
<argument index="0" name="n" type="int" />
<argument index="1" name="m" type="int" />
<description>
</description>
</method>
2023-02-12 19:17:06 +01:00
</methods>
<constants>
</constants>
</class>