*
* @since 2.0
*
- * The %DoubleMatrix3 class provides a @c double precision, two-dimensional matrix class.
+ * The %DoubleMatrix3 class provides a @c double precision, two-dimensional matrix.
*
*/
class _OSP_EXPORT_ DoubleMatrix3
public:
/**
* This is the default constructor for this class. @n
- * Constructs a 3 X 3 null matrix in which all elements are zero.
+ * Constructs a 3 X 3 null matrix in which all the elements are zero.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %DoubleMatrix3
+ * @param[in] rhs An instance of %DoubleMatrix3 to copy
*/
DoubleMatrix3(const DoubleMatrix3& rhs);
*
* @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 %DoubleMatrix3
*/
*
* @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 %DoubleMatrix3
*/
*
* @since 2.0
*
- * @return The reference to this instance
+ * @return A reference to this instance
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3& operator =(const DoubleMatrix3& rhs);
*
* @since 2.0
*
- * @return The reference to this instance
- * @param[in] value A @c double value to assign
+ * @return A reference to this instance
+ * @param[in] value The @c double value to assign
*/
DoubleMatrix3& operator =(double value);
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3 operator *(const DoubleMatrix3& rhs) const;
/**
- * Multiplies the value to each matrix members of current instance of %DoubleMatrix3.
+ * Multiplies the value to each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to multiply
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to multiply
*/
DoubleMatrix3 operator *(double value) const;
/**
- * Adds the value of the specified instance and the current instance of %DoubleMatrix3.
+ * Adds the value of the specified instance to the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3 operator +(const DoubleMatrix3& rhs) const;
/**
- * Adds the value to each matrix members of current instance of %DoubleMatrix3.
+ * Adds the value to each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to add
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to add
*/
DoubleMatrix3 operator +(double value) const;
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3 operator -(const DoubleMatrix3& rhs) const;
/**
- * Subtracts the value from each matrix members of current instance of %DoubleMatrix3.
+ * Subtracts the value from each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to subtract
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to subtract
*/
DoubleMatrix3 operator -(double value) const;
/**
- * Multiplies the value of the specified instance and the current instance of %DoubleMatrix3.
+ * Multiplies the value of the specified instance with the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3& operator *=(const DoubleMatrix3& rhs);
/**
- * Multiplies the value to each matrix members of current instance of %DoubleMatrix3.
+ * Multiplies the value to each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to multiply
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to multiply
*/
DoubleMatrix3& operator *=(double value);
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3& operator +=(const DoubleMatrix3& rhs);
/**
- * Adds the value to each matrix members of current instance of %DoubleMatrix3.
+ * Adds the value to each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to add
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to add
*/
DoubleMatrix3& operator +=(double value);
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3& operator -=(const DoubleMatrix3& rhs);
/**
- * Subtracts the value from each matrix members of current instance of %DoubleMatrix3.
+ * Subtracts the value from each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to subtract
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to subtract
*/
DoubleMatrix3& operator -=(double value);
/**
- * Gets the instance of %DoubleMatrix3 resulting from the sum of the value and the specified instance of %DoubleMatrix3.
+ * Gets an instance of %DoubleMatrix3 resulting from the sum of the value and the specified instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to add
- * @param[in] rhs An instance of %DoubleMatrix3
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to add
+ * @param[in] rhs An instance of %DoubleMatrix3
*/
_OSP_EXPORT_ friend DoubleMatrix3 operator +(const double& value, const DoubleMatrix3& rhs);
/**
- * Gets the instance of %DoubleMatrix3 resulting from the product of the value and the specified instance of %DoubleMatrix3.
+ * Gets an instance of %DoubleMatrix3 resulting from the product of the value and the specified instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to multiply
- * @param[in] rhs An instance of %DoubleMatrix3
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to multiply
+ * @param[in] rhs An instance of %DoubleMatrix3
*/
_OSP_EXPORT_ friend DoubleMatrix3 operator *(const double& value, const DoubleMatrix3& rhs);
/**
- * Gets the instance of %DoubleMatrix3 resulting from the difference between the value and the specified instance of %DoubleMatrix3.
+ * Gets an instance of %DoubleMatrix3 resulting from the difference between the value and the specified instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to subtract
- * @param[in] rhs An instance of %DoubleMatrix3
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to subtract
+ * @param[in] rhs An instance of %DoubleMatrix3
*/
_OSP_EXPORT_ friend DoubleMatrix3 operator -(const double& value, const DoubleMatrix3& rhs);
* @return @c true if the values of the current instance is equal to the value of the specified instance, @n
* else @c false
* @param[in] obj An instance of %DoubleMatrix3
- * @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 A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @remarks This function must be called after checking whether the matrix is invertible or not.
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @remarks This method must be called after checking whether the matrix is invertible or not.
*/
DoubleMatrix3 GetInverse(void) const;
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
*/
DoubleMatrix3 GetTranspose(void) const;
bool IsInvertible(void) const;
/**
- * Negates the matrix members of current instance of %DoubleMatrix3.
+ * Negates the matrix members of the current instance of %DoubleMatrix3.
*
* @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 invertible.
*/
result Invert(void);
/**
- * Sets the transposed matrix to the current instance of %DoubleMatrix3.
+ * Sets the transposed matrix of the current instance of %DoubleMatrix3.
*
* @since 2.0
*/
void Transpose(void);
/**
- * Sets the matrix members of current instance of %DoubleMatrix3 to zero.
+ * Sets the matrix members of the current instance of %DoubleMatrix3 to zero.
*
* @since 2.0
*/
}; // DoubleMatrix3
}} // Tizen::Base
-#endif //_FBASE_DOUBLE_MATRIX3_H_
\ No newline at end of file
+#endif //_FBASE_DOUBLE_MATRIX3_H_