行列の特異値分解 (convenience function)

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

Syntax

C#
public static int fnFIE_mat_svd2(
	FMATRIX_PTR a,
	ref FMATRIX_PTR u,
	ref FVECTOR_PTR sigma,
	ref FMATRIX_PTR vt,
	int mode,
	double rcond,
	ref int rank
)
Visual Basic
Public Shared Function fnFIE_mat_svd2 ( 
	a As FMATRIX_PTR,
	ByRef u As FMATRIX_PTR,
	ByRef sigma As FVECTOR_PTR,
	ByRef vt As FMATRIX_PTR,
	mode As Integer,
	rcond As Double,
	ByRef rank As Integer
) As Integer

Parameters

a
Type: fvalgcli..::..FMATRIX_PTR
入力 MxN 行列
u
Type: fvalgcli..::..FMATRIX_PTR%
直交行列 のポインタ。fnFIE_mat_aalloc()で確保したメモリのアドレス、または IntPtr.Zero を指定します。
sigma
Type: fvalgcli..::..FVECTOR_PTR%
大きい順( sigma(i) ≧ sigma(i+1) )にソートされた特異値配列。 fnFIE_mat_valloc()で確保したメモリのアドレス、または IntPtr.Zero を指定します。
vt
Type: fvalgcli..::..FMATRIX_PTR%
直交行列。fnFIE_mat_aalloc()で確保したメモリのアドレス、または IntPtr.Zero を指定します。
mode
Type: System..::..Int32
演算モード指定。次の何れかの値を指定。
( M = a->row, N = a->col, K = min(M,N), L = max(M,N) とおく )
  • 0: full SVD ( *u は MxM 行列, *vt は NxN 行列, *sigma の次元は L ) (*sigma)->v[K] から (*sigma)->v[L-1] は常にゼロになります。
  • 1: M≦N の時、full SVD ( mode=0 の場合と一緒 ) M＞N の時、 economy SVD ( u は MxK 行列, vt は KxN 行列, *sigma の次元は L ) (*sigma)->v[K] から (*sigma)->v[L-1] は常にゼロになります。
  • 2: economy SVD ( u は MxK 行列, vt は KxN 行列, *sigma の次元は K )
rcond
Type: System..::..Double
ランク計算時の閾値設定 ランク計算時に 特異値 sigma[i] ≦ rcond*sigma[0] の値をゼロと見なします。 rcond＜0.0 の値が指定されたときは、max(sigma) * eps の値を使用します。 rank に IntPtr.Zero が指定された場合は本パラメータは使用されません。
rank
Type: System..::..Int32%
ランクの値。

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_svd2()
        {
            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
            FVECTOR_PTR sigma = FVECTOR_PTR.Zero;
            int mode = new int();
            double tol = new double();
            int rank = new int();
            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 = api.fnFIE_mat_valloc(3);
                Assert.IsTrue(sigma != FVECTOR_PTR.Zero, "エラーが発生しました。");

                int status = (int)f_err.F_ERR_NONE;
                status = api.fnFIE_mat_svd2(a, ref u, ref sigma, ref vt, mode, tol, ref rank);
                Assert.IsTrue(status == (int)f_err.F_ERR_NONE, "エラーが発生しました。({0})", (f_err)status);
            }
            catch (System.Exception ex)
            {
                Assert.Fail(ex.Message);
            }
            finally
            {
                api.fnFIE_mat_afree(a);
                api.fnFIE_mat_afree(u);
                api.fnFIE_mat_afree(vt);
                api.fnFIE_mat_vfree(sigma);
            }
        }
    }
}

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_svd2()
        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 FVECTOR_PTR = FVECTOR_PTR.Zero
        Dim mode As New Integer()
        Dim tol As New Double()
        Dim rank As New Integer()
        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 = api.fnFIE_mat_valloc(3)
            Assert.IsTrue(sigma <> FVECTOR_PTR.Zero, "エラーが発生しました。")

            Dim status As Integer = CInt(f_err.F_ERR_NONE)
            status = api.fnFIE_mat_svd2(a, u, sigma, vt, mode, tol, _
                rank)
            Assert.IsTrue(status = CInt(f_err.F_ERR_NONE), "エラーが発生しました。({0})", CType(status, f_err))
        Catch ex As System.Exception
            Assert.Fail(ex.Message)
        Finally
            api.fnFIE_mat_afree(a)
            api.fnFIE_mat_afree(u)
            api.fnFIE_mat_afree(vt)
            api.fnFIE_mat_vfree(sigma)
        End Try
    End Sub
End Class

See Also