X-Git-Url: http://git.osdn.net/view?p=nyartoolkit-and%2Fnyartoolkit-and.git;a=blobdiff_plain;f=lib%2Fsrc%2Fjp%2Fnyatla%2Fnyartoolkit%2Fcore%2FNyARVec.java;h=f419eacfb0d062899ec6ca89f5890eebd1612fba;hp=a38a0a6aed06a73e6dc263ab54a8291fa5d63be5;hb=c57e553fedfa0adb843aaa67c1ccd30888fadd27;hpb=025913508d9428fe2cd554766fb5b5cc46c1a26f

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java b/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java
index a38a0a6..f419eac 100644
--- a/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java
@@ -33,23 +33,37 @@ package jp.nyatla.nyartoolkit.core;
 import jp.nyatla.nyartoolkit.NyARException;
 
 
-
+/**
+ * このクラスは、ARToolKit由来のベクトル値計算関数を提供します。
+ * <p>memo:
+ * このクラスは、今後統合・削除する可能性があります。
+ * </p>
+ */
 public class NyARVec
 {
+	/** ベクトルの列数*/
 	private int clm;
+	/** ベクトル値を格納する配列*/
+	private double[] v;
 
+
+	/**
+	 * コンストラクタです。
+	 * 列数を指定して、インスタンスを生成します。
+	 * @param i_clm
+	 * 列数です。
+	 */
 	public NyARVec(int i_clm)
 	{
 		v = new double[i_clm];
 		clm = i_clm;
 	}
 
-	private double[] v;
-
 	/**
-	 * i_clmサイズの列を格納できるように列サイズを変更します。 実行後、列の各値は不定になります。
-	 * 
+	 * ベクトルのバッファサイズを、i_clmに十分になるように変更します。
+	 * 実行後、列の各値は不定になります。
 	 * @param i_clm
+	 * 新しい列数
 	 */
 	public void realloc(int i_clm)
 	{
@@ -62,26 +76,36 @@ public class NyARVec
 		this.clm = i_clm;
 	}
 
+	/**
+	 * ベクトルの列数を返します。
+	 * @return
+	 * ベクトルの列数
+	 */
 	public int getClm()
 	{
 		return clm;
 	}
 
+	/**
+	 * ベクトル値を格納した配列の参照値を返します。
+	 * @return
+	 * 配列の参照値
+	 */
 	public double[] getArray()
 	{
 		return v;
 	}
 
-
-
 	/**
-	 * arVecInnerproduct関数の代替品
-	 * 
-	 * @param x
+	 * arVecInnerproduct関数の同等品です。
+	 * この関数は動作チェックをしておらず、機能しません。
+	 * 詳細は不明です。
 	 * @param y
+	 * 不明。
 	 * @param i_start
-	 *            演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)
+	 * 演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)
 	 * @return
+	 * 不明。
 	 * @throws NyARException
 	 */
 	public double vecInnerproduct(NyARVec y, int i_start) throws NyARException
@@ -102,12 +126,12 @@ public class NyARVec
 	}
 
 	/**
-	 * double arVecHousehold関数の代替品
-	 * 
-	 * @param x
+	 * arVecHousehold関数の同等品です。
+	 * 詳細は不明です。
 	 * @param i_start
-	 *            演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)
+	 * 演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)
 	 * @return
+	 * 不明。
 	 * @throws NyARException
 	 */
 	public double vecHousehold(int i_start) throws NyARException
@@ -135,10 +159,11 @@ public class NyARVec
 	}
 
 	/**
-	 * 現在ラップしている配列を取り外して、新しい配列をラップします。
-	 * 
-	 * @param i_v
+	 * 現在ラップしている配列を取り外して、新しい配列と、列数をセットします。
+	 * @param i_array
+	 * 新しく設定する配列です。この配列は、thisが所有します。
 	 * @param i_clm
+	 * 新しいVectorの列数です。
 	 */
 	public void setNewArray(double[] i_array, int i_clm)
 	{