//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
* This header file contains the declarations of the %DoubleMatrix class.
*
*/
-
#ifndef _FBASE_DOUBLE_MATRIX_H_
#define _FBASE_DOUBLE_MATRIX_H_
*
* @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 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
+ * else @c copy in column-major order
*/
DoubleMatrix(int rowCount, int columnCount, const double* pArray, bool rowMajor = true);
*
* @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
- * else @c false
+ * @return @c true if all 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
*/
bool operator ==(const DoubleMatrix& rhs) const;
*
* @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 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 %DoubleMatrix
*/
bool operator !=(const DoubleMatrix& rhs) const;
*
* @since 2.0
*
- * @return The reference to this instance
+ * @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,
+ * @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.
*/
DoubleMatrix& operator =(const DoubleMatrix& 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 %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;
*
* @since 2.0
*
- * @return The hash value of the current instance
- * @remarks Two equal instances must return the same hash value. For better performance,
+ * @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.
*/
virtual int GetHashCode(void) const;
*
* @since 2.0
*
- * @return The number of column in the current instance
+ * @return The number of column in the current instance
*/
int GetColumnCount(void) const;
*
* @since 2.0
*
- * @return A pointer to @c double array
+ * @return A pointer to @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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
double* GetColumnN(int columnIndex) const;
*
* @since 2.0
*
- * @return The determinant value of the current instance
+ * @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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks If the current instance is not a square matrix, return zero.
*/
double 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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
double GetElement(int rowIndex, int columnIndex) const;
*
* @since 2.0
*
- * @return A pointer to the instance of %DoubleMatrix containing the resulting value of the operation
+ * @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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
DoubleMatrix* GetInverseN(void) const;
*
* @since 2.0
*
- * @return A pointer to @c double array
+ * @return A pointer to @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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
double* GetRowN(int rowIndex) const;
*
* @since 2.0
*
- * @return A pointer to the instance of %DoubleMatrix containing the resulting value of the operation
+ * @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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
DoubleMatrix* GetTransposeN(void) const;
*
* @since 2.0
*
- * @return @c true if the matrix is an identity matrix, @n
- * else @c false
+ * @return @c true if the matrix is an identity matrix, @n
+ * else @c false
*/
bool IsIdentity(void) const;
*
* @since 2.0
*
- * @return @c true if the matrix is invertible, @n
- * else @c false
+ * @return @c true if the matrix is invertible, @n
+ * else @c false
*/
bool IsInvertible(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The target column number in the current instance
+ * @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.
* @since 2.0
*
* @return An error code
- * @param[in] rowIndex The target row number in the current instance
+ * @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.
* @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
+ * else @c copy in column-major order
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The @c pArray is @c null.
*/
int __column;
}; // DoubleMatrix
-
}} // Tizen::Base
-
-#endif //_FBASE_DOUBLE_MATRIX_H_
+#endif //_FBASE_DOUBLE_MATRIX_H_
\ No newline at end of file
projects / platform / framework / native / appfw.git / blobdiff