Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
TwoDArray_UnitTests.cpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include "Teuchos_UnitTestHarness.hpp"
43 #include "Teuchos_TwoDArray.hpp"
44 
45 
46 
47 namespace Teuchos{
48 
49 TwoDArray<int> getSimpleTestTwoDArray(){
50  TwoDArray<int> simpleArray(2,2);
51  simpleArray(0,0) =1;
52  simpleArray(0,1) =2;
53  simpleArray(1,0) =3;
54  simpleArray(1,1) =4;
55  return simpleArray;
56 }
57 
58 
62 TEUCHOS_UNIT_TEST(Teuchos_TwoDArrays, simpleTest){
63  TwoDArray<int> simpleArray(3,2);
64  simpleArray[0][0] =1;
65  simpleArray[0][1] =2;
66  simpleArray[1][0] =3;
67  simpleArray[1][1] =4;
68  simpleArray[2][0] =5;
69  simpleArray[2][1] =6;
70 
71  TEST_EQUALITY_CONST(simpleArray[0][0],1)
72  TEST_EQUALITY_CONST(simpleArray[0][1],2)
73  TEST_EQUALITY_CONST(simpleArray[1][0],3)
74  TEST_EQUALITY_CONST(simpleArray[1][1],4)
75  TEST_EQUALITY_CONST(simpleArray[2][0],5)
76  TEST_EQUALITY_CONST(simpleArray[2][1],6)
77 
78  TwoDArray<int> const& simpleArrayConst = simpleArray;
79 
80  TEST_EQUALITY_CONST(simpleArrayConst[0][0],1)
81  TEST_EQUALITY_CONST(simpleArrayConst[0][1],2)
82  TEST_EQUALITY_CONST(simpleArrayConst[1][0],3)
83  TEST_EQUALITY_CONST(simpleArrayConst[1][1],4)
84  TEST_EQUALITY_CONST(simpleArrayConst[2][0],5)
85  TEST_EQUALITY_CONST(simpleArrayConst[2][1],6)
86 
87  TEST_EQUALITY_CONST(simpleArray(0,0),1)
88  TEST_EQUALITY_CONST(simpleArray(0,1),2)
89  TEST_EQUALITY_CONST(simpleArray(1,0),3)
90  TEST_EQUALITY_CONST(simpleArray(1,1),4)
91  TEST_EQUALITY_CONST(simpleArray(2,0),5)
92  TEST_EQUALITY_CONST(simpleArray(2,1),6)
93 
94  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 3)
95  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 2)
96  Array<int> oneDArray = tuple<int>(1,2,3,4,5,6);
97  TEST_COMPARE_ARRAYS(oneDArray, simpleArray.getDataArray())
98 
99 }
100 
101 TEUCHOS_UNIT_TEST(Teuchos_TwoDArrays, stringFunctions){
102  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
103  std::string stringRep = TwoDArray<int>::toString(simpleArray);
104  TwoDArray<int> convertedArray = TwoDArray<int>::fromString(stringRep);
105  TEST_EQUALITY(simpleArray, convertedArray)
106 
107  std::string badStringRep = "4x4:{1.0,1.0}";
108  TEST_THROW(TwoDArray<int>::fromString(badStringRep),
109  InvalidArrayStringRepresentation)
110 }
111 
112 TEUCHOS_UNIT_TEST(Teuchos_TwoDArrays, emptyTest){
113  TwoDArray<int> emptyArray;
114  TEST_EQUALITY_CONST(emptyArray.getNumRows(), 0)
115  TEST_EQUALITY_CONST(emptyArray.getNumCols(), 0)
116  TEST_EQUALITY_CONST(emptyArray.getDataArray().size(), 0)
117  TEST_ASSERT(emptyArray.isEmpty());
118 }
119 
120 TEUCHOS_UNIT_TEST(Teuchos_TwoDArrays, streamTests){
121  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
122  std::stringstream ss;
123  ss << simpleArray;
124  TwoDArray<int> readArray;
125  std::istringstream instream(ss.str());
126  instream >> readArray;
127  TEST_EQUALITY(simpleArray, readArray);
128 }
129 
130 TEUCHOS_UNIT_TEST(Teuchos_TwoDArray, clearTest){
131  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
132 
133  simpleArray.clear();
134  TEST_ASSERT(simpleArray.isEmpty());
135 }
136 
137 TEUCHOS_UNIT_TEST(Teuchos_TwoDArray, resizeTest){
138  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
139 
140  simpleArray.resizeRows(4);
141  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 4);
142  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 2);
143  TEST_EQUALITY_CONST(simpleArray(3,1), 0);
144  TEST_EQUALITY_CONST(simpleArray(1,1), 4);
145 
146  simpleArray.resizeRows(2);
147  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 2);
148  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 2);
149 #ifdef HAVE_TEUCHOS_ARRAY_BOUNDSCHECK
150  TEST_THROW(simpleArray(3,1), RangeError);
151 #endif
152  TEST_EQUALITY_CONST(simpleArray(1,1), 4);
153 
154  simpleArray.resizeCols(4);
155  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 4);
156  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 2);
157  TEST_EQUALITY_CONST(simpleArray(1,3), 0);
158  TEST_EQUALITY_CONST(simpleArray(1,1), 4);
159 
160  simpleArray.resizeCols(2);
161  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 2);
162  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 2);
163 #ifdef HAVE_TEUCHOS_ARRAY_BOUNDSCHECK
164  TEST_THROW(simpleArray(1,3), RangeError);
165 #endif
166  TEST_EQUALITY_CONST(simpleArray(1,1), 4);
167 
168 }
169 
170 TEUCHOS_UNIT_TEST(Teuchos_TwoDArray, symmetryTest){
171  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
172  TEST_ASSERT(!simpleArray.isSymmetrical());
173  simpleArray.setSymmetrical(true);
174  TEST_ASSERT(simpleArray.isSymmetrical());
175 
176 }
177 
178 TEUCHOS_UNIT_TEST(Teuchos_TwoDArray, symmetrySerialization){
179  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
180  simpleArray.setSymmetrical(true);
181  std::string arrayString = TwoDArray<int>::toString(simpleArray);
182  TwoDArray<int> readIn = TwoDArray<int>::fromString(arrayString);
183  TEST_ASSERT(readIn.isSymmetrical());
184 }
185 
186 
187 } //namespace Teuchos
188 
Teuchos::TwoDArray::isSymmetrical
bool isSymmetrical() const
A simple flag indicating whether or not this TwoDArray should be interpurted as symmetrical.
Definition: Teuchos_TwoDArray.hpp:163
Teuchos::TwoDArray
A thin wrapper around the Array class which causes it to be interpreted as a 2D Array.
Definition: Teuchos_TwoDArray.hpp:68
Teuchos::Array::size
size_type size() const
Definition: Teuchos_Array.hpp:1017
Teuchos::TwoDArray::getNumRows
size_type getNumRows() const
returns the number of rows in the TwoDArray.
Definition: Teuchos_TwoDArray.hpp:113
Teuchos::TwoDArray::clear
void clear()
delets all the entries from the TwoDArray
Definition: Teuchos_TwoDArray.hpp:138
TEST_THROW
#define TEST_THROW(code, ExceptType)
Assert that the statement 'code' throws the exception 'ExceptType' (otherwise the test fails).
Definition: Teuchos_LocalTestingHelpers.hpp:198
Teuchos::TEUCHOS_UNIT_TEST
TEUCHOS_UNIT_TEST(ConstNonconstObjectContainer, create)
Definition: ConstNonconstObjectContainer.cpp:48
Teuchos::InvalidArrayStringRepresentation
Definition: Teuchos_Array.hpp:68
Teuchos_UnitTestHarness.hpp
Unit testing support.
Teuchos::Array< int >
Teuchos::TwoDArray::getDataArray
const Array< T > & getDataArray() const
Returns the 1D array that is backing this TwoDArray.
Definition: Teuchos_TwoDArray.hpp:123
Teuchos::TwoDArray::setSymmetrical
void setSymmetrical(bool symmetrical)
Sets whether or not the the TwoDArray should be interpurted as symetric.
Definition: Teuchos_TwoDArray.hpp:182
Teuchos::getSimpleTestTwoDArray
TwoDArray< int > getSimpleTestTwoDArray()
Definition: TwoDArray_UnitTests.cpp:49
Teuchos::TwoDArray::resizeCols
void resizeCols(size_type numberOfCols)
Changes the number of rows in the matrix.
Definition: Teuchos_TwoDArray.hpp:281
Teuchos::TwoDArray::toString
static std::string toString(const TwoDArray< T > array)
Converts a given TwoDArray to a valid string representation.
Definition: Teuchos_TwoDArray.hpp:295
TEST_EQUALITY_CONST
#define TEST_EQUALITY_CONST(v1, v2)
Assert the equality of v1 and constant v2.
Definition: Teuchos_LocalTestingHelpers.hpp:79
Teuchos::TwoDArray::resizeRows
void resizeRows(size_type numberOfRows)
Changes the number of rows in the matrix.
Definition: Teuchos_TwoDArray.hpp:274
Teuchos::TwoDArray::getNumCols
size_type getNumCols() const
returns the number of columns in the TwoDArray.
Definition: Teuchos_TwoDArray.hpp:118
Teuchos::TwoDArray::fromString
static TwoDArray< T > fromString(const std::string &string)
Converts a valid string to it's corresponding TwoDArray.
Definition: Teuchos_TwoDArray.hpp:311
Teuchos::RangeError
Range error exception class.
Definition: Teuchos_Exceptions.hpp:93
TEST_COMPARE_ARRAYS
#define TEST_COMPARE_ARRAYS(a1, a2)
Assert that a1.size()==a2.size() and a[i]==b[i], i=0....
Definition: Teuchos_LocalTestingHelpers.hpp:172
Teuchos_TwoDArray.hpp
A thin wrapper around the Teuchos Array class that allows for 2 dimensional arrays.
Teuchos
Definition: Teuchos_AbstractFactory.hpp:47
Teuchos::TEST_EQUALITY
TEST_EQUALITY(rcp_dynamic_cast< const EnhancedNumberValidator< double > >(castedDep1->getValuesAndValidators().find("val1") ->second, true) ->getMax(), double1Vali->getMax())
Teuchos::TEST_ASSERT
TEST_ASSERT(castedDep1->getValuesAndValidators().size()==2)
Teuchos::TwoDArray::isEmpty
bool isEmpty()
Definition: Teuchos_TwoDArray.hpp:144
Generated by   doxygen 1.8.16