X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseDoubleMatrix3.h;h=86d99f2a2b21dc8e31e48595cfcd4dc9f5f4764d;hb=72749ddd32dd1e3e2833ada50fad8fceefbdcddc;hp=4a4f81f571bb81e94d948c2f87e600bf03f33e3e;hpb=ba579df8b7bd47e2875e4833455443f56683ee01;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseDoubleMatrix3.h b/inc/FBaseDoubleMatrix3.h index 4a4f81f..86d99f2 100644 --- a/inc/FBaseDoubleMatrix3.h +++ b/inc/FBaseDoubleMatrix3.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Base * * @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 @@ -45,7 +45,7 @@ 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 */ @@ -56,7 +56,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %DoubleMatrix3 + * @param[in] rhs An instance of %DoubleMatrix3 to copy */ DoubleMatrix3(const DoubleMatrix3& rhs); @@ -81,7 +81,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 %DoubleMatrix3 */ @@ -92,7 +92,7 @@ public: * * @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 */ @@ -103,7 +103,7 @@ public: * * @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); @@ -113,8 +113,8 @@ public: * * @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); @@ -123,38 +123,38 @@ public: * * @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; @@ -163,38 +163,38 @@ public: * * @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); @@ -203,18 +203,18 @@ public: * * @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); @@ -223,51 +223,51 @@ public: * * @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); @@ -279,7 +279,9 @@ public: * @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; @@ -289,8 +291,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; @@ -308,8 +310,8 @@ public: * * @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; @@ -327,7 +329,7 @@ public: * * @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; @@ -352,7 +354,7 @@ public: 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 */ @@ -371,20 +373,20 @@ 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 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 */ @@ -405,4 +407,4 @@ private: }; // DoubleMatrix3 }} // Tizen::Base -#endif //_FBASE_DOUBLE_MATRIX3_H_ \ No newline at end of file +#endif //_FBASE_DOUBLE_MATRIX3_H_