*
* @since 2.0
*
- * The %IntMatrix class provides a int precision, two-dimensional matrix class.
+ * The %IntMatrix class provides a @c int precision, two-dimensional matrix.
*
*/
class _OSP_EXPORT_ IntMatrix
*
* @since 2.0
*
- * @param[in] rhs An instance of %IntMatrix
+ * @param[in] rhs An instance of %IntMatrix to copy
*/
IntMatrix(const IntMatrix& 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
*
*
* @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
*/
*
* @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.
*/
IntMatrix(int rowCount, int columnCount, const int* pArray[]);
*
* @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 %IntMatrix
*/
*
* @since 2.0
*
- * @return @c true if all matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n
+ * @return @c true if all the matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n
* else @c false
* @param[in] rhs An instance of %IntMatrix
*/
*
* @since 2.0
*
- * @return The reference to this instance
+ * @return A reference to this instance
* @param[in] rhs An instance of %IntMatrix
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
- * @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.
+ * @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 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.
*/
IntMatrix& operator =(const IntMatrix& rhs);
* @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 %IntMatrix
- * @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;
* @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;
* @since 2.0
*
* @return An error code
- * @param[in] matrix An instance of %IntMatrix
- * @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 %IntMatrix
+ * @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 IntMatrix& matrix);
/*
- * Adds the value to each matrix members of current instance of %IntMatrix.
+ * Adds the value to each matrix member of the current instance of %IntMatrix.
*
* @since 2.0
*
- * @param[in] value A @c int value to add
+ * @param[in] value The @c int value to add
*/
void AddToEachElement(int value);
/*
- * Gets the number of column in the current instance of %IntMatrix.
+ * Gets the number of columns in the current instance of %IntMatrix.
*
* @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;
*
* @since 2.0
*
- * @return A pointer to @c int 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.
+ * @return A pointer to the @c int array
+ * @param[in] columnIndex The target column number in the current instance
+ * @exception E_INVALID_ARG The specified @c columnIndex is larger than the column count of the current instance.
*/
int* GetColumnN(int columnIndex) const;
*
* @since 2.0
*
- * @return The determinant value of the current instance
- * @exception E_INVALID_OPERATION The current instance is not a square matrix.
- * @remarks If the current instance is not a square matrix, return zero.
+ * @return The determinant value of the current instance
+ * @exception E_INVALID_OPERATION The current instance is not a square matrix.
+ * @remarks If the current instance is not a square matrix, it returns zero.
*/
int GetDeterminant(void) const;
*
* @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.
+ * @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 specified @c columnIndex or the specified @c rowIndex is larger than that of the current instance.
*/
int GetElement(int rowIndex, int columnIndex) const;
*
* @since 2.0
*
- * @return A pointer to the instance of %IntMatrix 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 %IntMatrix containing the resulting value of the operation
+ * @exception E_INVALID_OPERATION The current instance is not a square matrix.
*/
IntMatrix* GetInverseN(void) const;
/*
- * Gets the number of row in the current instance of %IntMatrix.
+ * Gets the number of rows in the current instance of %IntMatrix.
*
* @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;
*
* @since 2.0
*
- * @return A pointer to @c int 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.
+ * @return A pointer to the @c int array
+ * @param[in] rowIndex The target row number in the current instance
+ * @exception E_INVALID_ARG The specified @c rowIndex is larger than the row count of the current instance.
*/
int* GetRowN(int rowIndex) const;
* @since 2.0
*
* @return An error code
- * @param[out] value A @c int value
- * @exception E_SUCCESS The method is successful.
+ * @param[out] value The @c int value
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current instance is not a square matrix.
*/
result GetTrace(int& value) const;
*
* @since 2.0
*
- * @return A pointer to the instance of %IntMatrix containing the resulting value of the operation
- * @exception E_INVALID_OPERATION The current instance is not a square matrix.
+ * @return A pointer to the %IntMatrix instance that contains the resulting value of the operation
+ * @exception E_INVALID_OPERATION The current instance is not a square matrix.
*/
IntMatrix* GetTransposeN(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] matrix An instance of %IntMatrix
- * @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 %IntMatrix
+ * @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 IntMatrix& matrix);
/*
- * Multiplies the value to each matrix members of current instance of %IntMatrix.
+ * Multiplies the value to each matrix member of the current instance of %IntMatrix.
*
* @since 2.0
*
- * @param[in] value A @c int value to multiply
+ * @param[in] value The @c int value to multiply
*/
void Multiply(int value);
/*
- * Negates the matrix members of current instance of %IntMatrix.
+ * Negates the matrix members of the current instance of %IntMatrix.
*
* @since 2.0
*/
* @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);
* @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);
* @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);
* @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 int* pArray);
* @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 int* pArray);
* @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 int 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 int 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, int value);
* @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 false to copy in column-major order
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The 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 false to 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 int* pArray, bool rowMajor = true);
/*
- * Sets the matrix members of current instance of %IntMatrix to zero.
+ * Sets the matrix members of the current instance of %IntMatrix to zero.
*
* @since 2.0
*/
* @since 2.0
*
* @return An error code
- * @param[in] matrix An instance of %IntMatrix
- * @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 %IntMatrix
+ * @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 IntMatrix& matrix);
/*
- * Subtracts the value from each matrix members of current instance of %IntMatrix.
+ * Subtracts the value from each matrix member of the current instance of %IntMatrix.
*
* @since 2.0
*
- * @param[in] value A @c int value to subtract
+ * @param[in] value The @c int value to subtract
*/
void SubtractToEachElement(int value);
projects / platform / framework / native / appfw.git / blobdiff