教師データオブジェクト
[機械学習]

教師データオブジェクトの生成

vec_dimension で指定された次元の特徴ベクトルを教師データとして 取り扱う教師データオブジェクトを作成し、そのハンドルを返します。 パラメータ不正や、メモリ不足などでオブジェクトを確保 できなかった場合は、NULLが返却されます。
生成されたハンドルが不要になったら fnFIE_free_object() にて解放してください。

指定する特徴ベクトルの次元は、0よりも大きい値である必要があります。

引数:

[in]

vec_dimension

特徴ベクトルの次元(0 < vec_dimension )

戻り値:

	正常終了	作成された教師データオブジェクトのハンドル
	NULL	異常終了(パラメータ不正、メモリ不足など)

教師データオブジェクトのパラメータ取得

hMl_sample で指定した教師データオブジェクトのパラメータを取得します。 取得できるのは、特徴ベクトルの次元数、現在設定されている教師データの数、です。

出力先の引数は全てNULLポインタチェックがされるため、必要の無いものについてはNULL指定が可能です。 このとき、 hMl_sample 以外のパラメータがNULLであっても、エラーにはならず正常終了します。

引数:

[in]	hMl_sample	情報を取得する教師データオブジェクトのハンドル
[out]	vec_dimension	特徴ベクトルの次元数
[out]	sample_num	設定されている教師データの数

戻り値:

	F_ERR_NONE	正常終了
	F_ERR_INVALID_OBJECT	入力された教師データオブジェクトが不正
	F_ERR_NO_LICENCE	ライセンスエラー、または未初期化エラー

教師データの追加

hMl_sample で指定した教師データオブジェクトに教師データを追加します。
sample_data で追加する特徴ベクトルを保持した配列の先頭ポインタ、 response で特徴ベクトルに対する ラベルを指定します。

sample_data で指定する配列は、 必ず hMl_sample で扱う特徴ベクトルの次元数だけのサイズを確保した配列にして下さい。 また、response は0以上の整数で指定してください。
sample_data で指定した配列の数値は、本関数内部で教師データオブジェクトにコピーされます。 そのため、本関数を呼び出した後に train_data に変更を加えても(配列内の数値を変更する、配列の領域を解放する等)、 オブジェクト内部のデータには影響はありません。

本関数内部でメモリ確保に失敗した場合は F_ERR_NOMEMORY を返しますが、 それ以前にオブジェクトに設定されていたデータは保持されたままになります。

引数:

[in]	hMl_sample	教師データを追加する教師データオブジェクトのハンドル
[in]	*sample_data	追加する教師データの特徴ベクトル
[in]	response	追加する教師データのラベル

戻り値:

	F_ERR_NONE	正常終了
	F_ERR_INVALID_PARAM	入力されたパラメータが不正
	F_ERR_INVALID_OBJECT	入力された教師データオブジェクトが不正
	F_ERR_NOMEMORY	メモリ不足による領域確保エラー
	F_ERR_NO_LICENCE	ライセンスエラー、または未初期化エラー