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 
43 #include "Teuchos_TwoDArray.hpp"
44 
45 
46 
47 namespace Teuchos{
48 
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  TEST_EQUALITY_CONST(simpleArray[0][0],1)
71  TEST_EQUALITY_CONST(simpleArray[0][1],2)
72  TEST_EQUALITY_CONST(simpleArray[1][0],3)
73  TEST_EQUALITY_CONST(simpleArray[1][1],4)
74  TEST_EQUALITY_CONST(simpleArray[2][0],5)
75  TEST_EQUALITY_CONST(simpleArray[2][1],6)
76 
77  TEST_EQUALITY_CONST(simpleArray(0,0),1)
78  TEST_EQUALITY_CONST(simpleArray(0,1),2)
79  TEST_EQUALITY_CONST(simpleArray(1,0),3)
80  TEST_EQUALITY_CONST(simpleArray(1,1),4)
81  TEST_EQUALITY_CONST(simpleArray(2,0),5)
82  TEST_EQUALITY_CONST(simpleArray(2,1),6)
83 
84  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 3)
85  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 2)
86  Array<int> oneDArray = tuple<int>(1,2,3,4,5,6);
87  TEST_COMPARE_ARRAYS(oneDArray, simpleArray.getDataArray())
88 
89 }
90 
91 TEUCHOS_UNIT_TEST(Teuchos_TwoDArrays, stringFunctions){
92  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
93  std::string stringRep = TwoDArray<int>::toString(simpleArray);
94  TwoDArray<int> convertedArray = TwoDArray<int>::fromString(stringRep);
95  TEST_EQUALITY(simpleArray, convertedArray)
96 
97  std::string badStringRep = "4x4:{1.0,1.0}";
100 }
101 
102 TEUCHOS_UNIT_TEST(Teuchos_TwoDArrays, emptyTest){
103  TwoDArray<int> emptyArray;
104  TEST_EQUALITY_CONST(emptyArray.getNumRows(), 0)
105  TEST_EQUALITY_CONST(emptyArray.getNumCols(), 0)
106  TEST_EQUALITY_CONST(emptyArray.getDataArray().size(), 0)
107  TEST_ASSERT(emptyArray.isEmpty());
108 }
109 
110 TEUCHOS_UNIT_TEST(Teuchos_TwoDArrays, streamTests){
111  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
112  std::stringstream ss;
113  ss << simpleArray;
114  TwoDArray<int> readArray;
115  std::istringstream instream(ss.str());
116  instream >> readArray;
117  TEST_EQUALITY(simpleArray, readArray);
118 }
119 
120 TEUCHOS_UNIT_TEST(Teuchos_TwoDArray, clearTest){
121  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
122 
123  simpleArray.clear();
124  TEST_ASSERT(simpleArray.isEmpty());
125 }
126 
127 TEUCHOS_UNIT_TEST(Teuchos_TwoDArray, resizeTest){
128  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
129 
130  simpleArray.resizeRows(4);
131  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 4);
132  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 2);
133  TEST_EQUALITY_CONST(simpleArray(3,1), 0);
134  TEST_EQUALITY_CONST(simpleArray(1,1), 4);
135 
136  simpleArray.resizeRows(2);
137  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 2);
138  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 2);
139 #ifdef HAVE_TEUCHOS_ARRAY_BOUNDSCHECK
140  TEST_THROW(simpleArray(3,1), RangeError);
141 #endif
142  TEST_EQUALITY_CONST(simpleArray(1,1), 4);
143 
144  simpleArray.resizeCols(4);
145  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 4);
146  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 2);
147  TEST_EQUALITY_CONST(simpleArray(1,3), 0);
148  TEST_EQUALITY_CONST(simpleArray(1,1), 4);
149 
150  simpleArray.resizeCols(2);
151  TEST_EQUALITY_CONST(simpleArray.getNumCols(), 2);
152  TEST_EQUALITY_CONST(simpleArray.getNumRows(), 2);
153 #ifdef HAVE_TEUCHOS_ARRAY_BOUNDSCHECK
154  TEST_THROW(simpleArray(1,3), RangeError);
155 #endif
156  TEST_EQUALITY_CONST(simpleArray(1,1), 4);
157 
158 }
159 
160 TEUCHOS_UNIT_TEST(Teuchos_TwoDArray, symmetryTest){
161  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
162  TEST_ASSERT(!simpleArray.isSymmetrical());
163  simpleArray.setSymmetrical(true);
164  TEST_ASSERT(simpleArray.isSymmetrical());
165 
166 }
167 
168 TEUCHOS_UNIT_TEST(Teuchos_TwoDArray, symmetrySerialization){
169  TwoDArray<int> simpleArray = getSimpleTestTwoDArray();
170  simpleArray.setSymmetrical(true);
171  std::string arrayString = TwoDArray<int>::toString(simpleArray);
172  TwoDArray<int> readIn = TwoDArray<int>::fromString(arrayString);
173  TEST_ASSERT(readIn.isSymmetrical());
174 }
175 
176 
177 } //namespace Teuchos
178 
A thin wrapper around the Teuchos Array class that allows for 2 dimensional arrays.
bool isSymmetrical() const
A simple flag indicating whether or not this TwoDArray should be interpurted as symmetrical.
void setSymmetrical(bool symmetrical)
Sets whether or not the the TwoDArray should be interpurted as symetric.
void clear()
delets all the entries from the TwoDArray
#define TEST_THROW(code, ExceptType)
Assert that the statement &#39;code&#39; throws the exception &#39;ExceptType&#39; (otherwise the test fails)...
size_type getNumRows() const
returns the number of rows in the TwoDArray.
const Array< T > & getDataArray() const
Returns the 1D array that is backing this TwoDArray.
static std::string toString(const TwoDArray< T > array)
Converts a given TwoDArray to a valid string representation.
TEUCHOS_UNIT_TEST(ConstNonconstObjectContainer, create)
A thin wrapper around the Array class which causes it to be interpurted as a 2D Array.
size_type getNumCols() const
returns the number of columns in the TwoDArray.
TwoDArray< int > getSimpleTestTwoDArray()
size_type size() const
Unit testing support.
#define TEST_EQUALITY_CONST(v1, v2)
Assert the equality of v1 and constant v2.
void resizeCols(size_type numberOfCols)
Changes the number of rows in the matrix.
void resizeRows(size_type numberOfRows)
Changes the number of rows in the matrix.
#define TEST_COMPARE_ARRAYS(a1, a2)
Assert that a1.size()==a2.size() and a[i]==b[i], i=0....
TEST_ASSERT(castedDep1->getValuesAndValidators().size()==2)
TEST_EQUALITY(rcp_dynamic_cast< const EnhancedNumberValidator< double > >(castedDep1->getValuesAndValidators().find("val1") ->second, true) ->getMax(), double1Vali->getMax())
Range error exception class.
static TwoDArray< T > fromString(const std::string &string)
Converts a valid string to it&#39;s corresponding TwoDArray.