行列の特異値分解

Namespace: fvalgcli
Assembly: fvalgcli (in fvalgcli.dll) Version: 3.1.0.0 (3.1.0.11)

Syntax

C#
public static int fnFIE_mat_svd(
	FMATRIX_PTR a,
	DOUBLE_PTR sigma,
	FMATRIX_PTR u,
	FMATRIX_PTR vt
)
Visual Basic
Public Shared Function fnFIE_mat_svd ( 
	a As FMATRIX_PTR,
	sigma As DOUBLE_PTR,
	u As FMATRIX_PTR,
	vt As FMATRIX_PTR
) As Integer

Parameters

a
Type: fvalgcli..::..FMATRIX_PTR
入力 MxN 行列
sigma
Type: fvalgcli..::..DOUBLE_PTR
大きい順( sigma(i) ≧ sigma(i+1) )にソートされた 特異値配列。 個の領域が必要。
u
Type: fvalgcli..::..FMATRIX_PTR
直交行列。
計算不要な場合は IntPtr.Zero を指定して下さい。 u に IntPtr.Zero を指定する場合は vt も IntPtr.Zero を指定しなければいけません。
vt
Type: fvalgcli..::..FMATRIX_PTR
直交行列。
計算不要な場合は IntPtr.Zero を指定して下さい。 vt に IntPtr.Zero を指定する場合は u も IntPtr.Zero を指定しなければいけません。

Return Value

Type: Int32
以下のエラーコードを返します。

エラーコード:
f_err内容
F_ERR_NONE正常終了
F_ERR_NOMEMORYメモリ不足エラー
F_ERR_CALC_IMPOSSIBLE計算不能エラー
F_ERR_INVALID_PARAMパラメータ異常
F_ERR_NO_LICENCEライセンスエラー、または未初期化エラー

Examples

C# Copy imageCopy
//    $Revision: 1.1 $

using System;
using System.Collections.Generic;
using System.Text;
using fvalgcli;

namespace TC
{
    public partial class FIE 
    {
        [FvPluginExecute]
        public void fnFIE_mat_svd()
        {
            const int ROW = 4;            // 入力行列の行数 (M)
            const int COL = 3;            // 入力行列の列数 (N)

            FMATRIX_PTR a = FMATRIX_PTR.Zero;        // 入力行列 MxN
            FMATRIX_PTR u = FMATRIX_PTR.Zero;        // 直交行列 MxN
            FMATRIX_PTR vt = FMATRIX_PTR.Zero;        // 直交行列 NxN
            DOUBLE_PTR sigma = DOUBLE_PTR.Zero;

            try
            {
                // 行列の生成.
                a = api.fnFIE_mat_aalloc(ROW, COL);
                u = api.fnFIE_mat_aalloc(ROW, ROW);
                vt = api.fnFIE_mat_aalloc(COL, COL);

                Assert.IsTrue(a != FMATRIX_PTR.Zero, "行列 a (ROW x COL) の生成に失敗しました。");
                Assert.IsTrue(u != FMATRIX_PTR.Zero, "行列 u (ROW x ROW) の生成に失敗しました。");
                Assert.IsTrue(vt != FMATRIX_PTR.Zero, "行列 vt (COL x COL) の生成に失敗しました。");

                int size = Math.Min(ROW, COL);    // 何れか小さい方.
                sigma = DOUBLE_PTR.alloc(size);

                int status = (int)f_err.F_ERR_NONE;
                status = api.fnFIE_mat_svd(a, sigma, u, vt);
                Assert.IsTrue(status == (int)f_err.F_ERR_NONE, "エラーが発生しました。({0})", (f_err)status);
            }
            finally
            {
                api.fnFIE_mat_afree(a);
                api.fnFIE_mat_afree(u);
                api.fnFIE_mat_afree(vt);
                sigma.Dispose();
            }
        }
    }
}


Visual Basic Copy imageCopy
'    $Revision: 1.1 $

Imports System.Collections.Generic
Imports System.Text
Imports fvalgcli

Public Partial Class FIE
    <FvPluginExecute> _
    Public Sub fnFIE_mat_svd()
        Const  ROW As Integer = 4
        ' 入力行列の行数 (M)
        Const  COL As Integer = 3
        ' 入力行列の列数 (N)
        Dim a As FMATRIX_PTR = FMATRIX_PTR.Zero
        ' 入力行列 MxN
        Dim u As FMATRIX_PTR = FMATRIX_PTR.Zero
        ' 直交行列 MxN
        Dim vt As FMATRIX_PTR = FMATRIX_PTR.Zero
        ' 直交行列 NxN
        Dim sigma As DOUBLE_PTR = DOUBLE_PTR.Zero

        Try
            ' 行列の生成.
            a = api.fnFIE_mat_aalloc(ROW, COL)
            u = api.fnFIE_mat_aalloc(ROW, ROW)
            vt = api.fnFIE_mat_aalloc(COL, COL)

            Assert.IsTrue(a <> FMATRIX_PTR.Zero, "行列 a (ROW x COL) の生成に失敗しました。")
            Assert.IsTrue(u <> FMATRIX_PTR.Zero, "行列 u (ROW x ROW) の生成に失敗しました。")
            Assert.IsTrue(vt <> FMATRIX_PTR.Zero, "行列 vt (COL x COL) の生成に失敗しました。")

            Dim size As Integer = Math.Min(ROW, COL)
            ' 何れか小さい方.
            sigma = DOUBLE_PTR.alloc(size)

            Dim status As Integer = CInt(f_err.F_ERR_NONE)
            status = api.fnFIE_mat_svd(a, sigma, u, vt)
            Assert.IsTrue(status = CInt(f_err.F_ERR_NONE), "エラーが発生しました。({0})", CType(status, f_err))
        Finally
            api.fnFIE_mat_afree(a)
            api.fnFIE_mat_afree(u)
            api.fnFIE_mat_afree(vt)
            sigma.Dispose()
        End Try
    End Sub
End Class

See Also