Refactory NumberSymbols.

[platform/framework/native/appfw.git] / inc / FBaseFloatMatrix.h

diff --git a/inc/FBaseFloatMatrix.h b/inc/FBaseFloatMatrix.h
index 9a54eb4..558f2d7 100644 (file)
--- a/inc/FBaseFloatMatrix.h
+++ b/inc/FBaseFloatMatrix.h
@@ -21,7 +21,6 @@
  * This header file contains the declarations of the %FloatMatrix class.
  *
  */
-
 #ifndef _FBASE_FLOAT_MATRIX_H_
 #define _FBASE_FLOAT_MATRIX_H_
 
@@ -70,7 +69,7 @@ public:
         *
         * @param[in]   rowCount        The number of rows in the current instance
         * @param[in]   columnCount     The number of columns in the current instance
-        * @param[in]   pArray  A one-dimensional array @n The array must be at least row * column in length.
+        * @param[in]   pArray          A one-dimensional array @n The array must be at least row * column in length.
         * @param[in]   rowMajor        Set to @c true to copy the array in row-major order, @n
         *                                                      else @c copy in column-major order
         */
@@ -121,11 +120,11 @@ public:
         *
         * @since 2.0
         *
-        * @return      The reference to this instance
+        * @return              The reference to this instance
         * @param[in]   rhs     An instance of %FloatMatrix
         * @exception   E_INVALID_ARG   Either row or column count of the current instance is not same with that of the specified instance.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
-        * @remarks     If either row or column count of the current instance is not same with that of the specified instance,
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
+        * @remarks             If either row or column count of the current instance is not same with that of the specified instance,
         *                              return the reference to this instance without assigning.
         */
        FloatMatrix& operator =(const FloatMatrix& rhs);
@@ -138,7 +137,7 @@ public:
         * @return      @c true if the values of the current instance are equal to the value of the specified instance, @n
         *                      else @c false
         * @param[in]   obj     An instance of %FloatMatrix
-        * @remarks     This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances.
+        * @remarks             This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances.
         */
        virtual bool Equals(const Tizen::Base::Object& obj) const;
 
@@ -149,7 +148,7 @@ public:
         *
         * @return      The hash value of the current instance
         * @remarks     Two equal instances must return the same hash value. For better performance,
-        *                              the used hash function must generate a random distribution for all inputs.
+        *                      the used hash function must generate a random distribution for all inputs.
         */
        virtual int GetHashCode(void) const;
 
@@ -159,8 +158,8 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   matrix  An instance of %FloatMatrix
-        * @exception   E_SUCCESS       The method is successful.
+        * @param[in]   matrix                  An instance of %FloatMatrix
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   Either row or column count of the current instance is not same with that of the specified instance.
         */
        result Add(const FloatMatrix& matrix);
@@ -189,9 +188,9 @@ public:
         * @since 2.0
         *
         * @return      A pointer to float array
-        * @param[in]   columnIndex     The target column number in the current instance
+        * @param[in]   columnIndex             The target column number in the current instance
         * @exception   E_INVALID_ARG   The @c columnIndex is larger than the column count of the current instance.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        float* GetColumnN(int columnIndex) const;
 
@@ -200,9 +199,9 @@ public:
         *
         * @since 2.0
         *
-        * @return      The determinant value of the current instance
+        * @return              The determinant value of the current instance
         * @exception   E_INVALID_OPERATION     The current instance is not a square matrix.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         * @remarks     If the current instance is not a square matrix, return zero.
         */
        float GetDeterminant(void) const;
@@ -213,10 +212,10 @@ public:
         * @since 2.0
         *
         * @return      The value at the specified row and column of the current instance
-        * @param[in]   rowIndex        The target row number in the current instance
-        * @param[in]   columnIndex     The target column number in the current instance
+        * @param[in]   rowIndex                The target row number in the current instance
+        * @param[in]   columnIndex             The target column number in the current instance
         * @exception   E_INVALID_ARG   The @c columnIndex or @c rowIndex is larger than that of the current instance.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        float GetElement(int rowIndex, int columnIndex) const;
 
@@ -225,9 +224,9 @@ public:
         *
         * @since 2.0
         *
-        * @return       A pointer to the instance of %FloatMatrix containing the resulting value of the operation
+        * @return              A pointer to the instance of %FloatMatrix containing the resulting value of the operation
         * @exception   E_INVALID_OPERATION     The current instance is not a square matrix.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        FloatMatrix* GetInverseN(void) const;
 
@@ -246,9 +245,9 @@ public:
         * @since 2.0
         *
         * @return      A pointer to @c float array
-        * @param[in]   rowIndex        The target row number in the current instance
+        * @param[in]   rowIndex                The target row number in the current instance
         * @exception   E_INVALID_ARG   The @c rowIndex is larger than the row count of the current instance.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        float* GetRowN(int rowIndex) const;
 
@@ -258,7 +257,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[out]  value   A @c float value
+        * @param[out]  value           A @c float value
         * @exception   E_SUCCESS       The method is successful.
         * @exception   E_INVALID_OPERATION     The current instance is not a square matrix.
         */
@@ -269,9 +268,9 @@ public:
         *
         * @since 2.0
         *
-        * @return       A pointer to the instance of %FloatMatrix containing the resulting value of the operation
-        * @exception   E_INVALID_OPERATION     The current instance is not a square matrix.
-        * @remarks    The specific error code can be accessed using the GetLastResult() method.
+        * @return              A pointer to the instance of %FloatMatrix containing the resulting value of the operation
+        * @exception   E_INVALID_OPERATION             The current instance is not a square matrix.
+        * @remarks             The specific error code can be accessed using the GetLastResult() method.
         */
        FloatMatrix* GetTransposeN(void) const;
 
@@ -301,8 +300,8 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   matrix  An instance of %FloatMatrix
-        * @exception   E_SUCCESS       The method is successful.
+        * @param[in]   matrix                  An instance of %FloatMatrix
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   The column count of the current instance is not same with the row count of the specified instance.
         */
        result Multiply(const FloatMatrix& matrix);
@@ -329,7 +328,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @exception   E_SUCCESS       The method is successful.
+        * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_OPERATION     The current instance is not a square matrix.
         */
        result SetAsIdentity(void);
@@ -340,7 +339,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @exception   E_SUCCESS       The method is successful.
+        * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_OPERATION     The current instance is not a square matrix.
         */
        result Invert(void);
@@ -351,7 +350,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @exception   E_SUCCESS       The method is successful.
+        * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_OPERATION     The current instance is not a square matrix.
         */
        result Transpose(void);
@@ -362,9 +361,9 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   columnIndex     The target column number in the current instance        
-        * @param[in]   pArray  An array which includes the values @n The array must be at least row in length.
-        * @exception   E_SUCCESS       The method is successful.
+        * @param[in]   columnIndex             The target column number in the current instance
+        * @param[in]   pArray                  An array which includes the values @n The array must be at least row in length.
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   The @c pArray is @c null, or the @c columnIndex is larger than the column count of the current instance.
         */
        result SetColumn(int columnIndex, const float* pArray);
@@ -375,9 +374,9 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   rowIndex        The target row number in the current instance   
-        * @param[in]   pArray  An array which includes the values @n The array must be at least column in length.
-        * @exception   E_SUCCESS       The method is successful.
+        * @param[in]   rowIndex        The target row number in the current instance
+        * @param[in]   pArray          An array which includes the values @n The array must be at least column in length.
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   The @c pArray is @c null, or the @c rowIndex is larger than the row count of the current instance.
         */
        result SetRow(int rowIndex, const float* pArray);
@@ -390,7 +389,7 @@ public:
         * @return              An error code
         * @param[in]   rowIndex        The target row number in the current instance
         * @param[in]   columnIndex     The target column number in the current instance
-        * @param[in]   value   A @c float value
+        * @param[in]   value           A @c float value
         * @exception   E_SUCCESS       The method is successful.
         * @exception   E_INVALID_ARG   The pArray is @c null, or the @c rowIndex is larger than the row count of the current instance,
         *                              or the @c columnIndex is larger than the column count of the current instance.
@@ -403,10 +402,10 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   pArray  A one-dimensional array @n The array must be at least row * column in length.
+        * @param[in]   pArray          A one-dimensional array @n The array must be at least row * column in length.
         * @param[in]   rowMajor        Set to @c true to copy the array in row-major order, @n
         *                                                      else @c false to copy in column-major order
-        * @exception   E_SUCCESS       The method is successful.
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   The pArray is @c null.
         */
        result SetValue(const float* pArray, bool rowMajor = true);
@@ -424,8 +423,8 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @param[in]   matrix  An instance of %FloatMatrix
-        * @exception   E_SUCCESS       The method is successful.
+        * @param[in]   matrix                  An instance of %FloatMatrix
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG   Either row or column count of the current instance is not same with that of the specified instance.
         */
        result Subtract(const FloatMatrix& matrix);