1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
|
/*
ARPACK++ v1.2 2/20/2000
c++ interface to ARPACK code.
MODULE ARRSSym.h.
Arpack++ class ARrcSymStdEig definition.
ARPACK Authors
Richard Lehoucq
Danny Sorensen
Chao Yang
Dept. of Computational & Applied Mathematics
Rice University
Houston, Texas
*/
#ifndef ARRSSYM_H
#define ARRSSYM_H
#include <cstddef>
#include "arch.h"
#include "arerror.h"
#include "debug.h"
#include "arrseig.h"
#include "saupp.h"
#include "seupp.h"
template<class ARFLOAT>
class ARrcSymStdEig: public virtual ARrcStdEig<ARFLOAT, ARFLOAT> {
protected:
// a) Protected functions:
// a.1) Memory control functions.
void WorkspaceAllocate();
// Allocates workspace for symmetric problems.
// a.2) Functions that handle original FORTRAN ARPACK code.
void Aupp();
// Interface to FORTRAN subroutines SSAUPD and DSAUPD.
void Eupp();
// Interface to FORTRAN subroutines SSEUPD and DSEUPD.
// a.3) Functions that check user defined parameters.
char* CheckWhich(char* whichp);
// Determines if the value of variable "which" is valid.
public:
// b) Public functions:
// b.1) Trace functions.
void Trace(const int digit = -5, const int getv0 = 0, const int aupd = 1,
const int aup2 = 0, const int aitr = 0, const int eigt = 0,
const int apps = 0, const int gets = 0, const int eupd = 0)
{
sTraceOn(digit, getv0, aupd, aup2, aitr, eigt, apps, gets, eupd);
}
// Turns on trace mode.
// b.2) Functions that permit step by step execution of ARPACK.
ARFLOAT* PutVector();
// When ido = -1, 1 or 2 and the user must perform a product in the form
// y <- M*x, this function indicates where to store y. When ido = 3, this
// function indicates where to store the shifts.
// b.3) Functions that perform all calculations in one step.
int FindSchurVectors() {
throw ArpackError(ArpackError::SCHUR_UNDEFINED, "FindSchurVectors");
return 0; // Only to avoid warning messages emitted by some compilers.
}
// For symmetric problems, Schur vectors are eigenvectors.
int Eigenvalues(ARFLOAT* &EigValp, bool ivec = false, bool ischur = false);
// Overrides array EigValp with the eigenvalues of the problem.
// Also calculates eigenvectors and Schur vectors if requested.
int EigenValVectors(ARFLOAT* &EigVecp, ARFLOAT* &EigValp,
bool ischur = false);
// Overrides array EigVecp sequentially with the eigenvectors of the
// given eigen-problem. Also stores the eigenvalues in EigValp.
// Calculates Schur vectors if requested.
// b.4) Functions that return elements of vectors and matrices.
ARFLOAT Eigenvalue(int i);
// Provides i-eth eigenvalue.
ARFLOAT Eigenvector(int i, int j);
// Provides element j of the i-eth eigenvector.
// b.5) Functions that use STL vector class.
#ifdef STL_VECTOR_H
vector<ARFLOAT>* StlEigenvalues(bool ivec = false, bool ischur = false);
// Calculates the eigenvalues and stores them in a single STL vector.
// Also calculates eigenvectors and Schur vectors if requested.
vector<ARFLOAT>* StlEigenvector(int i);
// Returns the i-th eigenvector in a STL vector.
#endif // #ifdef STL_VECTOR_H.
// b.6) Constructors and destructor.
ARrcSymStdEig() { }
// Short constructor.
ARrcSymStdEig(int np, int nevp, char* whichp = "LM", int ncvp = 0,
ARFLOAT tolp = 0.0, int maxitp = 0, ARFLOAT* residp = NULL,
bool ishiftp = true);
// Long constructor (regular mode).
ARrcSymStdEig(int np, int nevp, ARFLOAT sigmap, char* whichp = "LM",
int ncvp = 0, ARFLOAT tolp = 0.0, int maxitp = 0,
ARFLOAT* residp = NULL, bool ishiftp = true);
// Long constructor (shift and invert mode).
ARrcSymStdEig(const ARrcSymStdEig& other) { Copy(other); }
// Copy constructor.
virtual ~ARrcSymStdEig() { }
// Destructor.
// c) Operators.
ARrcSymStdEig& operator=(const ARrcSymStdEig& other);
// Assignment operator.
}; // class ARrcSymStdEig.
// ------------------------------------------------------------------------ //
// ARrcSymStdEig member functions definition. //
// ------------------------------------------------------------------------ //
template<class ARFLOAT>
inline void ARrcSymStdEig<ARFLOAT>::WorkspaceAllocate()
{
this->lworkl = this->ncv*(this->ncv+9);
this->lworkv = 0;
this->lrwork = 0;
this->workl = new ARFLOAT[this->lworkl+1];
} // WorkspaceAllocate.
template<class ARFLOAT>
inline void ARrcSymStdEig<ARFLOAT>::Aupp()
{
saupp(this->ido, this->bmat, this->n, this->which, this->nev, this->tol, this->resid, this->ncv, this->V, this->n,
this->iparam, this->ipntr, this->workd, this->workl, this->lworkl, this->info);
} // Aupp.
template<class ARFLOAT>
inline void ARrcSymStdEig<ARFLOAT>::Eupp()
{
seupp(this->rvec, this->HowMny, this->EigValR, this->EigVec, this->n, this->sigmaR, this->bmat,
this->n, this->which, this->nev, this->tol, this->resid, this->ncv, this->V, this->n, this->iparam,
this->ipntr, this->workd, this->workl, this->lworkl, this->info);
} // Eupp.
template<class ARFLOAT>
char* ARrcSymStdEig<ARFLOAT>::CheckWhich(char* whichp)
{
switch (whichp[0]) {
case 'B': // The options are: BE, ...
return "BE";
case 'L': // LA, LM, ...
case 'S': // SA, SM.
switch (whichp[1]){
case 'A':
case 'M':
return whichp;
}
default:
throw ArpackError(ArpackError::WHICH_UNDEFINED);
}
} // CheckWhich.
template<class ARFLOAT>
ARFLOAT* ARrcSymStdEig<ARFLOAT>::PutVector()
{
switch (this->ido) {
case -1:
case 1: // Returning OP*x.
case 2:
return &this->workd[this->ipntr[2]]; // Returning B*x.
case 3:
return &this->workl[this->ipntr[11]]; // Returning shifts.
default:
throw ArpackError(ArpackError::CANNOT_PUT_VECTOR, "PutVector");
}
} // PutVector.
template<class ARFLOAT>
int ARrcSymStdEig<ARFLOAT>::
Eigenvalues(ARFLOAT* &EigValp, bool ivec, bool ischur)
{
if (this->ValuesOK) { // Eigenvalues are available.
if (EigValp == NULL) { // Moving eigenvalues.
EigValp = this->EigValR;
this->EigValR = NULL;
this->newVal = false;
this->ValuesOK = false;
}
else { // Copying eigenvalues.
copy(this->nconv,this->EigValR,1,EigValp,1);
}
}
else { // Eigenvalues are not available.
if (this->newVal) {
delete[] this->EigValR;
this->newVal = false;
}
if (EigValp == NULL) {
try { EigValp = new ARFLOAT[this->ValSize()]; }
catch (ArpackError) { return 0; }
}
this->EigValR = EigValp;
if (ivec) { // Finding eigenvalues and eigenvectors.
this->nconv = this->FindEigenvectors(ischur);
}
else { // Finding eigenvalues only.
this->nconv = this->FindEigenvalues();
}
this->EigValR = NULL;
}
return this->nconv;
} // Eigenvalues(EigValp, ivec, ischur).
template<class ARFLOAT>
int ARrcSymStdEig<ARFLOAT>::
EigenValVectors(ARFLOAT* &EigVecp, ARFLOAT* &EigValp, bool ischur)
{
if (this->ValuesOK) { // Eigenvalues are already available .
this->nconv = Eigenvalues(EigValp, false);
this->nconv = Eigenvectors(EigVecp, ischur);
}
else { // Eigenvalues and vectors are not available.
try {
if (this->EigVecp == NULL) this->EigVecp = new ARFLOAT[this->ValSize()*this->n];
if (this->EigValp == NULL) this->EigValp = new ARFLOAT[this->ValSize()];
}
catch (ArpackError) { return 0; }
if (this->newVec) {
delete[] this->EigVec;
this->newVec = false;
}
if (this->newVal) {
delete[] this->EigValR;
this->newVal = false;
}
this->EigVec = this->EigVecp;
this->EigValR = this->EigValp;
this->nconv = this->FindEigenvectors(ischur);
this->EigVec = NULL;
this->EigValR = NULL;
}
return this->nconv;
} // EigenValVectors(EigVecp, EigValp, ischur).
template<class ARFLOAT>
inline ARFLOAT ARrcSymStdEig<ARFLOAT>::Eigenvalue(int i)
{
// Returning i-eth eigenvalue.
if (!this->ValuesOK) {
throw ArpackError(ArpackError::VALUES_NOT_OK, "Eigenvalue(i)");
}
else if ((i>=this->nconv)||(i<0)) {
throw ArpackError(ArpackError::RANGE_ERROR, "Eigenvalue(i)");
}
return this->EigValR[i];
} // Eigenvalue(i).
template<class ARFLOAT>
inline ARFLOAT ARrcSymStdEig<ARFLOAT>::Eigenvector(int i, int j)
{
// Returning element j of i-eth eigenvector.
if (!this->VectorsOK) {
throw ArpackError(ArpackError::VECTORS_NOT_OK, "Eigenvector(i,j)");
}
else if ((i>=this->nconv)||(i<0)||(j>=this->n)||(j<0)) {
throw ArpackError(ArpackError::RANGE_ERROR, "Eigenvector(i,j)");
}
return this->EigVec[i*this->n+j];
} // Eigenvector(i,j).
#ifdef STL_VECTOR_H
template<class ARFLOAT>
inline vector<ARFLOAT>* ARrcSymStdEig<ARFLOAT>::
StlEigenvalues(bool ivec, bool ischur)
{
// Returning the eigenvalues in a STL vector.
vector<ARFLOAT>* StlEigValR;
ARFLOAT* ValPtr;
try { StlEigValR = new vector<ARFLOAT>(ValSize()); }
catch (ArpackError) { return NULL; }
ValPtr = StlEigValR->begin();
nconv = Eigenvalues(ValPtr, ivec, ischur);
return StlEigValR;
} // StlEigenvalues.
template<class ARFLOAT>
inline vector<ARFLOAT>* ARrcSymStdEig<ARFLOAT>::StlEigenvector(int i)
{
// Returning the i-th eigenvector in a STL vector.
vector<ARFLOAT>* Vec;
if (!VectorsOK) {
throw ArpackError(ArpackError::VECTORS_NOT_OK, "StlEigenvector(i)");
}
else if ((i>=ValSize())||(i<0)) {
throw ArpackError(ArpackError::RANGE_ERROR, "StlEigenvector(i)");
}
try {
Vec = new vector<ARFLOAT>(&EigVec[i*n], &EigVec[(i+1)*n]);
}
catch (ArpackError) { return NULL; }
return Vec;
} // StlEigenvector(i).
#endif // #ifdef STL_VECTOR_H.
template<class ARFLOAT>
inline ARrcSymStdEig<ARFLOAT>::
ARrcSymStdEig(int np, int nevp, char* whichp, int ncvp,
ARFLOAT tolp, int maxitp, ARFLOAT* residp, bool ishiftp)
{
this->NoShift();
this->DefineParameters(np, nevp, whichp, ncvp, tolp, maxitp, residp, ishiftp);
} // Long constructor (regular mode).
template<class ARFLOAT>
inline ARrcSymStdEig<ARFLOAT>::
ARrcSymStdEig(int np, int nevp, ARFLOAT sigmap, char* whichp,
int ncvp, ARFLOAT tolp, int maxitp, ARFLOAT* residp,
bool ishiftp)
{
this->ChangeShift(sigmap);
this->DefineParameters(np, nevp, whichp, ncvp, tolp, maxitp, residp, ishiftp);
} // Long constructor (shift and invert mode).
template<class ARFLOAT>
ARrcSymStdEig<ARFLOAT>& ARrcSymStdEig<ARFLOAT>::
operator=(const ARrcSymStdEig<ARFLOAT>& other)
{
if (this != &other) { // Stroustrup suggestion.
this->ClearMem();
Copy(other);
}
return *this;
} // operator=.
#endif // ARRSSYM_H
|