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