X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=inc%2FFBaseDoubleMatrix.h;h=04f65b99e2832dbce351501a4e2b074458c29fc8;hb=72749ddd32dd1e3e2833ada50fad8fceefbdcddc;hp=35d035cc334f67bc75fa62fcfa05ddc0efa10473;hpb=1d2dc38595600c1a3f1cd91c89e7fee509bc4b97;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseDoubleMatrix.h b/inc/FBaseDoubleMatrix.h index 35d035c..04f65b9 100644 --- a/inc/FBaseDoubleMatrix.h +++ b/inc/FBaseDoubleMatrix.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %DoubleMatrix class provides a @c double precision, two-dimensional matrix class. + * The %DoubleMatrix class provides a @c double precision, two-dimensional matrix. * */ class _OSP_EXPORT_ DoubleMatrix @@ -48,12 +48,12 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %DoubleMatrix + * @param[in] rhs An instance of %DoubleMatrix to copy */ DoubleMatrix(const DoubleMatrix& rhs); /** - * Constructs a row by column null matrix in which all elements are zero. + * Constructs a row by column null matrix in which all the elements are zero. * * @since 2.0 * @@ -69,7 +69,8 @@ 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 The 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 */ @@ -82,7 +83,8 @@ 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 two-dimensional array @n The array must be at least row * column in length. + * @param[in] pArray[] The two-dimensional array @n + * The array must be at least row * column in length. */ DoubleMatrix(int rowCount, int columnCount, const double* pArray[]); @@ -99,7 +101,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %DoubleMatrix */ @@ -121,12 +123,13 @@ public: * * @since 2.0 * - * @return The reference to this instance - * @param[in] rhs An instance of %DoubleMatrix - * @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, - * return the reference to this instance without assigning. + * @return A reference to this instance + * @param[in] rhs An instance of %DoubleMatrix + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If either the row or the column count of the current instance is not same as that of the specified instance, + * this method returns the reference to this instance without assigning. */ DoubleMatrix& operator =(const DoubleMatrix& rhs); @@ -135,10 +138,12 @@ public: * * @since 2.0 * - * @return @c true if the values of the current instance are equal to the value of the specified instance, @n + * @return @c true if the values of the current instance are equal to the values of the specified instance, @n * else @c false * @param[in] obj An instance of %DoubleMatrix - * @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; @@ -148,8 +153,8 @@ public: * @since 2.0 * * @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. + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -159,27 +164,27 @@ public: * @since 2.0 * * @return An error code - * @param[in] matrix An instance of %DoubleMatrix - * @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. + * @param[in] matrix An instance of %DoubleMatrix + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. */ result Add(const DoubleMatrix& matrix); /** - * Adds the value to each matrix members of the current instance of %DoubleMatrix. + * Adds the value to each matrix member of the current instance of %DoubleMatrix. * * @since 2.0 * - * @param[in] value A @c double value to add + * @param[in] value The @c double value to add */ void AddToEachElement(double value); /** - * Gets the number of column in the current instance of %DoubleMatrix. + * Gets the number of columns in the current instance of %DoubleMatrix. * * @since 2.0 * - * @return The number of column in the current instance + * @return The number of columns in the current instance */ int GetColumnCount(void) const; @@ -188,8 +193,8 @@ public: * * @since 2.0 * - * @return A pointer to @c double array - * @param[in] columnIndex The target column number in the current instance + * @return A pointer to the @c double array + * @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. */ @@ -201,9 +206,10 @@ public: * @since 2.0 * * @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 If the current instance is not a square matrix, return zero. + * @exception E_INVALID_OPERATION The current instance is not a square matrix. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the current instance is not a square matrix, this method returns zero. */ double GetDeterminant(void) const; @@ -213,9 +219,9 @@ 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 - * @exception E_INVALID_ARG The @c columnIndex or @c rowIndex is larger than that 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 + * @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. */ double GetElement(int rowIndex, int columnIndex) const; @@ -225,18 +231,18 @@ public: * * @since 2.0 * - * @return A pointer to the instance of %DoubleMatrix containing the resulting value of the operation - * @exception E_INVALID_OPERATION The current instance is not a square matrix. + * @return A pointer to the instance of %DoubleMatrix that contains 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. */ DoubleMatrix* GetInverseN(void) const; /** - * Gets the number of row in the current instance of %DoubleMatrix. + * Gets the number of rows in the current instance of %DoubleMatrix. * * @since 2.0 * - * @return The number of row in the current instance + * @return The number of rows in the current instance */ int GetRowCount(void) const; @@ -245,8 +251,8 @@ public: * * @since 2.0 * - * @return A pointer to @c double array - * @param[in] rowIndex The target row number in the current instance + * @return A pointer to the @c double array + * @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. */ @@ -258,8 +264,8 @@ public: * @since 2.0 * * @return An error code - * @param[out] value A @c double value - * @exception E_SUCCESS The method is successful. + * @param[out] value The @c double value + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not a square matrix. */ result GetTrace(double& value) const; @@ -269,8 +275,8 @@ public: * * @since 2.0 * - * @return A pointer to the instance of %DoubleMatrix containing the resulting value of the operation - * @exception E_INVALID_OPERATION The current instance is not a square matrix. + * @return A pointer to the %DoubleMatrix instance that contains 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. */ DoubleMatrix* GetTransposeN(void) const; @@ -301,18 +307,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] matrix An instance of %DoubleMatrix - * @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. + * @param[in] matrix An instance of %DoubleMatrix + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The column count of the current instance is not same as the row count of the specified instance. */ result Multiply(const DoubleMatrix& matrix); /** - * Multiplies the value with each matrix members of the current instance of %DoubleMatrix. + * Multiplies the value with each matrix member of the current instance of %DoubleMatrix. * * @since 2.0 * - * @param[in] value A @c double value to multiply + * @param[in] value The @c double value to multiply */ void Multiply(double value); @@ -329,7 +335,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 +346,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 +357,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,10 +368,13 @@ 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. - * @exception E_INVALID_ARG The @c pArray is @c null, or the @c columnIndex is larger than the column count of the current instance. + * @param[in] columnIndex The target column number in the current instance + * @param[in] pArray The 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 Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c columnIndex is larger than the column count of the current instance. */ result SetColumn(int columnIndex, const double* pArray); @@ -375,10 +384,13 @@ 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. - * @exception E_INVALID_ARG The @c pArray is @c null, or the @c rowIndex is larger than the row count of the current instance. + * @param[in] rowIndex The target row number in the current instance + * @param[in] pArray The 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 Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c rowIndex is larger than the row count of the current instance. */ result SetRow(int rowIndex, const double* pArray); @@ -388,31 +400,34 @@ public: * @since 2.0 * * @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 double 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. + * @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 The @c double value + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c rowIndex is larger than the row count of the current instance. + * - The specified @c columnIndex is larger than the column count of the current instance. */ result SetElement(int rowIndex, int columnIndex, double value); /** - * Sets the values to the current instance of %DoubleMatrix in either the row-major or column-major order. + * Sets the values to the current instance of %DoubleMatrix in either the row-major or the column-major order. * * @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] rowMajor Set to @c true to copy the array in row-major order, @n - * else @c copy in column-major order - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c pArray is @c null. + * @param[in] pArray The 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 + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c pArray is @c null. */ result SetValue(const double* pArray, bool rowMajor = true); /** - * Sets the matrix members of current instance of %DoubleMatrix to zero. + * Sets the matrix members of the current instance of %DoubleMatrix to zero. * * @since 2.0 */ @@ -424,18 +439,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] matrix An instance of %DoubleMatrix - * @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. + * @param[in] matrix An instance of %DoubleMatrix + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. */ result Subtract(const DoubleMatrix& matrix); /** - * Subtracts the value from each matrix members of the current instance of %DoubleMatrix. + * Subtracts the value from each matrix member of the current instance of %DoubleMatrix. * * @since 2.0 * - * @param[in] value A @c double value to subtract + * @param[in] value The @c double value to subtract */ void SubtractToEachElement(double value); @@ -460,4 +475,4 @@ private: }; // DoubleMatrix }} // Tizen::Base -#endif //_FBASE_DOUBLE_MATRIX_H_ \ No newline at end of file +#endif //_FBASE_DOUBLE_MATRIX_H_