git-svn-id: http://svn.sourceforge.jp/svnroot/nyartoolkit/NyARToolkit/trunk@786 7cac0...

[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / core / NyARVec.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java b/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java
index a38a0a6..f419eac 100644 (file)
--- 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;\r
 \r
 \r
-\r
+/**\r
+ * このクラスは、ARToolKit由来のベクトル値計算関数を提供します。\r
+ * <p>memo:\r
+ * このクラスは、今後統合・削除する可能性があります。\r
+ * </p>\r
+ */\r
 public class NyARVec\r
 {\r
+       /** ベクトルの列数*/\r
        private int clm;\r
+       /** ベクトル値を格納する配列*/\r
+       private double[] v;\r
 \r
+\r
+       /**\r
+        * コンストラクタです。\r
+        * 列数を指定して、インスタンスを生成します。\r
+        * @param i_clm\r
+        * 列数です。\r
+        */\r
        public NyARVec(int i_clm)\r
        {\r
                v = new double[i_clm];\r
                clm = i_clm;\r
        }\r
 \r
-       private double[] v;\r
-\r
        /**\r
-        * i_clmサイズの列を格納できるように列サイズを変更します。 実行後、列の各値は不定になります。\r
-        * \r
+        * ベクトルのバッファサイズを、i_clmに十分になるように変更します。\r
+        * 実行後、列の各値は不定になります。\r
         * @param i_clm\r
+        * 新しい列数\r
         */\r
        public void realloc(int i_clm)\r
        {\r
@@ -62,26 +76,36 @@ public class NyARVec
                this.clm = i_clm;\r
        }\r
 \r
+       /**\r
+        * ベクトルの列数を返します。\r
+        * @return\r
+        * ベクトルの列数\r
+        */\r
        public int getClm()\r
        {\r
                return clm;\r
        }\r
 \r
+       /**\r
+        * ベクトル値を格納した配列の参照値を返します。\r
+        * @return\r
+        * 配列の参照値\r
+        */\r
        public double[] getArray()\r
        {\r
                return v;\r
        }\r
 \r
-\r
-\r
        /**\r
-        * arVecInnerproduct関数の代替品\r
-        * \r
-        * @param x\r
+        * arVecInnerproduct関数の同等品です。\r
+        * この関数は動作チェックをしておらず、機能しません。\r
+        * 詳細は不明です。\r
         * @param y\r
+        * 不明。\r
         * @param i_start\r
-        *            演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)\r
+        * 演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)\r
         * @return\r
+        * 不明。\r
         * @throws NyARException\r
         */\r
        public double vecInnerproduct(NyARVec y, int i_start) throws NyARException\r
@@ -102,12 +126,12 @@ public class NyARVec
        }\r
 \r
        /**\r
-        * double arVecHousehold関数の代替品\r
-        * \r
-        * @param x\r
+        * arVecHousehold関数の同等品です。\r
+        * 詳細は不明です。\r
         * @param i_start\r
-        *            演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)\r
+        * 演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)\r
         * @return\r
+        * 不明。\r
         * @throws NyARException\r
         */\r
        public double vecHousehold(int i_start) throws NyARException\r
@@ -135,10 +159,11 @@ public class NyARVec
        }\r
 \r
        /**\r
-        * ç\8f¾å\9c¨ã\83©ã\83\83ã\83\97ã\81\97ã\81¦ã\81\84ã\82\8bé\85\8då\88\97ã\82\92å\8f\96ã\82\8aå¤\96ã\81\97ã\81¦ã\80\81æ\96°ã\81\97ã\81\84é\85\8då\88\97ã\82\92ã\83©ã\83\83ã\83\97します。\r
-        * \r
-        * @param i_v\r
+        * ç\8f¾å\9c¨ã\83©ã\83\83ã\83\97ã\81\97ã\81¦ã\81\84ã\82\8bé\85\8då\88\97ã\82\92å\8f\96ã\82\8aå¤\96ã\81\97ã\81¦ã\80\81æ\96°ã\81\97ã\81\84é\85\8då\88\97ã\81¨ã\80\81å\88\97æ\95°ã\82\92ã\82»ã\83\83ã\83\88します。\r
+        * @param i_array\r
+        * 新しく設定する配列です。この配列は、thisが所有します。\r
         * @param i_clm\r
+        * 新しいVectorの列数です。\r
         */\r
        public void setNewArray(double[] i_array, int i_clm)\r
        {\r