Utility functions for use in unit tests. More...

#include "Mesquite.hpp"
#include "Vector3D.hpp"
#include "Matrix3D.hpp"
#include "MsqMatrix.hpp"
#include "MsqError.hpp"
#include <string>
#include <cstdio>
#include "cppunit/extensions/HelperMacros.h"

Include dependency graph for UnitUtil.hpp:

Go to the source code of this file.

Defines
#define	ASSERT_MESSAGE(MSG, COND) CPPUNIT_NS::Asserter::failIf( !( COND ), ( MSG ), CPPUNIT_SOURCELINE() )
#define	ASSERT_NO_ERROR(A) ASSERT_MESSAGE( ( A ).error_message(), !MSQ_CHKERR( ( A ) ) )
#define	CPPUNIT_ASSERT_VECTORS_EQUAL(v1, v2, eps) ASSERT_MESSAGE( utest_vect_message( ( v1 ), ( v2 ) ), utest_vect_equal( ( v1 ), ( v2 ), ( eps ) ) )
	compare two vectors (Vector3D)
#define	CPPUNIT_ASSERT_MATRICES_EQUAL(m1, m2, eps) ASSERT_MESSAGE( utest_mat_message( ( m1 ), ( m2 ) ), utest_mat_equal( ( m1 ), ( m2 ), ( eps ) ) )
	compare two matrices (Matrix3D)
#define	ASSERT_IDENTITY_MATRIX(M) ASSERT_MESSAGE( ident_check_msg( M ), ident_check( M ) )
#define	ASSERT_MATRICES_EQUAL(A, B, E) ASSERT_MESSAGE( mat_equal_check_msg( A, B ), mat_equal_check( A, B, E ) )
#define	ASSERT_MATRICES_DIFFERENT(A, B, E) ASSERT_MESSAGE( mat_not_equal_check_msg( A, B ), !mat_equal_check( A, B, E ) )
#define	ASSERT_ARRAYS_EQUAL(A, B, LEN)
#define	ASSERT_STD_VECTORS_EQUAL(A, B)
Functions
std::string	utest_vect_str (const MBMesquite::Vector3D &v)
std::string	utest_mat_str (const MBMesquite::Matrix3D &m)
std::string	utest_mat_str (const MBMesquite::SymMatrix3D &m)
CppUnit::Message	utest_vect_message (const MBMesquite::Vector3D &v1, const MBMesquite::Vector3D &v2)
CppUnit::Message	utest_mat_message (const MBMesquite::Matrix3D &m1, const MBMesquite::Matrix3D &m2)
CppUnit::Message	utest_mat_message (const MBMesquite::SymMatrix3D &m1, const MBMesquite::SymMatrix3D &m2)
bool	utest_vect_equal (const MBMesquite::Vector3D &v1, const MBMesquite::Vector3D &v2, double eps)
bool	utest_mat_equal (const MBMesquite::Matrix3D &m1, const MBMesquite::Matrix3D &m2, double eps)
bool	utest_mat_equal (const MBMesquite::SymMatrix3D &m1, const MBMesquite::SymMatrix3D &m2, double eps)
template<unsigned R, unsigned C>
std::string	msq_mat_str (const MBMesquite::MsqMatrix< R, C > &m)
template<unsigned R, unsigned C>
CppUnit::Message	ident_check_msg (const MBMesquite::MsqMatrix< R, C > &m)
template<unsigned R, unsigned C>
bool	ident_check (const MBMesquite::MsqMatrix< R, C > &m)
template<unsigned R, unsigned C>
CppUnit::Message	mat_equal_check_msg (const MBMesquite::MsqMatrix< R, C > &A, const MBMesquite::MsqMatrix< R, C > &B)
template<unsigned R, unsigned C>
CppUnit::Message	mat_not_equal_check_msg (const MBMesquite::MsqMatrix< R, C > &A, const MBMesquite::MsqMatrix< R, C > &B)
template<unsigned R, unsigned C>
bool	mat_equal_check (const MBMesquite::MsqMatrix< R, C > &A, const MBMesquite::MsqMatrix< R, C > &B, double eps)
template<typename T1 , typename T2 >
bool	arrays_equal (const T1 A, const T2 B, size_t len)
template<typename T1 , typename T2 >
CppUnit::Message	arrays_not_equal_msg (const T1 A, size_t A_len, const T2 B, size_t B_len)

Detailed Description

Utility functions for use in unit tests.

Author:: Jason Kraftcheck

Definition in file UnitUtil.hpp.

Define Documentation

#define ASSERT_ARRAYS_EQUAL	(	A,
		B,
		LEN
	)

Value:

CPPUNIT_NS::Asserter::failIf( !( arrays_equal( ( A ), ( B ), ( LEN ) ) ), \
                                  arrays_not_equal_msg( ( A ), ( LEN ), ( B ), ( LEN ) ), CPPUNIT_SOURCELINE() )

compare two arrays of values

Definition at line 78 of file UnitUtil.hpp.

Referenced by PatchDataTest::test_quad8_patch().

#define ASSERT_IDENTITY_MATRIX ( M ) ASSERT_MESSAGE( ident_check_msg( M ), ident_check( M ) )

compare matrix (MsqMatrix) with the identity matrix

Definition at line 68 of file UnitUtil.hpp.

Referenced by TargetCalculatorTest::test_ideal_shape_hex(), TargetCalculatorTest::test_ideal_shape_quad(), TargetCalculatorTest::test_ideal_skew_hex(), TargetCalculatorTest::test_ideal_skew_quad(), MsqMatrixTest::test_initialize(), MsqMatrixTest::test_inverse(), MsqMatrixTest::test_matrix_add(), MsqMatrixTest::test_matrix_subtract(), MsqMatrixTest::test_qr(), MsqMatrixTest::test_scalar_add(), MsqMatrixTest::test_scalar_multiply(), and MsqMatrixTest::test_scalar_subtract().

#define ASSERT_MATRICES_DIFFERENT	(	A,
		B,
		E
	)	ASSERT_MESSAGE( mat_not_equal_check_msg( A, B ), !mat_equal_check( A, B, E ) )

compare two matrices (MsqMatrix)

Definition at line 74 of file UnitUtil.hpp.

#define ASSERT_MATRICES_EQUAL	(	A,
		B,
		E
	)	ASSERT_MESSAGE( mat_equal_check_msg( A, B ), mat_equal_check( A, B, E ) )

compare two matrices (MsqMatrix)

Definition at line 71 of file UnitUtil.hpp.

#define ASSERT_MESSAGE	(	MSG,
		COND
	)	CPPUNIT_NS::Asserter::failIf( !( COND ), ( MSG ), CPPUNIT_SOURCELINE() )

Definition at line 46 of file UnitUtil.hpp.

Referenced by LinearMappingFunctionTest::do_coeff_test(), LinearMappingFunctionTest::do_deriv_test(), and MsqMeshEntityTest::test_check_element_orientation().

#define ASSERT_NO_ERROR ( A ) ASSERT_MESSAGE( ( A ).error_message(), !MSQ_CHKERR( ( A ) ) )

Assert that MBMesquite API has not flagged an error

Definition at line 49 of file UnitUtil.hpp.

#define ASSERT_STD_VECTORS_EQUAL	(	A,
		B
	)

Value:

CPPUNIT_NS::Asserter::failIf( ( ( A ) != ( B ) ),                                                       \
                                  arrays_not_equal_msg( &( A )[0], ( A ).size(), &( B )[0], ( B ).size() ), \
                                  CPPUNIT_SOURCELINE() )

Definition at line 82 of file UnitUtil.hpp.

Referenced by QualityMetricTest::compare_indices(), and ArrayMeshTest::test_tag_data().

#define CPPUNIT_ASSERT_MATRICES_EQUAL	(	m1,
		m2,
		eps
	)	ASSERT_MESSAGE( utest_mat_message( ( m1 ), ( m2 ) ), utest_mat_equal( ( m1 ), ( m2 ), ( eps ) ) )

compare two matrices (Matrix3D)

Ensure that the test result Matrix3D m2 is within eps of the expected matrix m1

Definition at line 64 of file UnitUtil.hpp.

#define CPPUNIT_ASSERT_VECTORS_EQUAL	(	v1,
		v2,
		eps
	)	ASSERT_MESSAGE( utest_vect_message( ( v1 ), ( v2 ) ), utest_vect_equal( ( v1 ), ( v2 ), ( eps ) ) )

compare two vectors (Vector3D)

Ensure that the test result Vector3D v2 is within eps of the expected vector v1 .

Definition at line 56 of file UnitUtil.hpp.

Function Documentation

template<typename T1 , typename T2 >

bool arrays_equal	(	const T1 *	A,
		const T2 *	B,
		size_t	len
	)		`[inline]`

Definition at line 230 of file UnitUtil.hpp.

{
    for( size_t i = 0; i < len; ++i )
        if( A[i] != B[i] ) return false;
    return true;
}

template<typename T1 , typename T2 >

CppUnit::Message arrays_not_equal_msg	(	const T1 *	A,
		size_t	A_len,
		const T2 *	B,
		size_t	B_len
	)		`[inline]`

Definition at line 238 of file UnitUtil.hpp.

{
    CppUnit::Message mes( "Equality Assertion Failed for Arrays" );

    std::ostringstream strA;
    if( A_len == 0 )
        strA << "(empty)";
    else
    {
        strA << '[' << A[0];
        for( size_t i = 1; i < A_len; ++i )
            strA << ',' << A[i];
        strA << ']';
    }
    mes.addDetail( std::string( "Expected: " ) + strA.str() );

    std::ostringstream strB;
    if( B_len == 0 )
        strB << "(empty)";
    else
    {
        strB << '[' << B[0];
        for( size_t i = 1; i < B_len; ++i )
            strB << ',' << B[i];
        strB << ']';
    }
    mes.addDetail( std::string( "Actual: " ) + strB.str() );

    return mes;
}