/usr/include/deal.II/lac/vector.h is in libdeal.ii-dev 6.3.1-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 | //---------------------------------------------------------------------------
// $Id: vector.h 20939 2010-04-06 03:53:19Z bangerth $
// Version: $Name$
//
// Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__vector_h
#define __deal2__vector_h
#include <base/config.h>
#include <base/exceptions.h>
#include <base/parallel.h>
#include <base/subscriptor.h>
#include <boost/lambda/lambda.hpp>
#include <cstdio>
#include <cstring>
#include <vector>
DEAL_II_NAMESPACE_OPEN
#ifdef DEAL_II_USE_PETSC
namespace PETScWrappers
{
class Vector;
namespace MPI
{
class Vector;
}
}
#endif
#ifdef DEAL_II_USE_TRILINOS
namespace TrilinosWrappers
{
namespace MPI
{
class Vector;
}
class Vector;
}
#endif
template<typename number> class LAPACKFullMatrix;
template <typename> class BlockVector;
template <typename> class VectorView;
/*! @addtogroup Vectors
*@{
*/
/**
* Numerical vector of data. For this class there are different types
* of functions available. The first type of function mesures the norm
* of the vector in order to mesure its length in a suitable norm. The
* second type support the abgebraic operation for vectors. The third
* und last type helps us to manipulate the components of the vector.
* As opposed to the array of the C++ standard library called
* @p vector (with a lowercase "v"), this class implements an element
* of a vector space suitable for numerical computations.
*
* @note Instantiations for this template are provided for
* <tt>@<float@>, @<double@>, @<long double@>,
* @<std::complex@<float@>@>, @<std::complex@<double@>@>,
* @<std::complex@<long double@>@></tt>; others can be generated in
* application programs (see the section on @ref Instantiations in the
* manual).
*
* @author Guido Kanschat, Franz-Theo Suttmeier, Wolfgang Bangerth
*/
template <typename Number>
class Vector : public Subscriptor
{
public:
/**
* Declare standard types used in all
* containers. These types parallel
* those in the <tt>C++</tt> standard libraries
* <tt>vector<...></tt> class.
*/
typedef Number value_type;
typedef value_type *pointer;
typedef const value_type *const_pointer;
typedef value_type *iterator;
typedef const value_type *const_iterator;
typedef value_type &reference;
typedef const value_type &const_reference;
typedef size_t size_type;
/**
* Declare a type that has holds
* real-valued numbers with the
* same precision as the template
* argument to this class. If the
* template argument of this
* class is a real data type,
* then real_type equals the
* template argument. If the
* template argument is a
* std::complex type then
* real_type equals the type
* underlying the complex
* numbers.
*
* This typedef is used to
* represent the return type of
* norms.
*/
typedef typename numbers::NumberTraits<Number>::real_type real_type;
public:
/**
* @name 1: Basic Object-handling
*/
//@{
/**
* Constructor. Create a vector of
* dimension zero.
*/
Vector ();
/**
* Copy-constructor. Sets the dimension
* to that of the given vector, and
* copies all elements.
*
* We would like to make this
* constructor explicit, but STL
* insists on using it implicitly.
*/
Vector (const Vector<Number> &v);
#ifndef DEAL_II_EXPLICIT_CONSTRUCTOR_BUG
/**
* Copy constructor taking a vector of
* another data type. This will fail if
* there is no conversion path from
* @p OtherNumber to @p Number. Note that
* you may lose accuracy when copying
* to a vector with data elements with
* less accuracy.
*
* Older versions of gcc did not honor
* the @p explicit keyword on template
* constructors. In such cases, it is
* easy to accidentally write code that
* can be very inefficient, since the
* compiler starts performing hidden
* conversions. To avoid this, this
* function is disabled if we have
* detected a broken compiler during
* configuration.
*/
template <typename OtherNumber>
explicit
Vector (const Vector<OtherNumber> &v);
#endif
#ifdef DEAL_II_USE_PETSC
/**
* Another copy constructor: copy the
* values from a sequential PETSc wrapper
* vector class. This copy constructor is
* only available if PETSc was detected
* during configuration time.
*/
Vector (const PETScWrappers::Vector &v);
/**
* Another copy constructor: copy the
* values from a parallel PETSc wrapper
* vector class. This copy constructor is
* only available if PETSc was detected
* during configuration time.
*
* Note that due to the communication
* model used in MPI, this operation can
* only succeed if all processes do it at
* the same time. I.e., it is not
* possible for only one process to
* obtain a copy of a parallel vector
* while the other jobs do something
* else.
*/
Vector (const PETScWrappers::MPI::Vector &v);
#endif
#ifdef DEAL_II_USE_TRILINOS
/**
* Another copy constructor: copy
* the values from a Trilinos
* wrapper vector. This copy
* constructor is only available if
* Trilinos was detected during
* configuration time.
*
* Note that due to the
* communication model used in MPI,
* this operation can only succeed
* if all processes do it at the
* same time. This means that it is
* not possible for only one
* process to obtain a copy of a
* parallel vector while the other
* jobs do something else. This
* call will rather result in a
* copy of the vector on all
* processors.
*/
Vector (const TrilinosWrappers::MPI::Vector &v);
/**
* Another copy constructor: copy
* the values from a localized
* Trilinos wrapper vector. This
* copy constructor is only
* available if Trilinos was
* detected during configuration
* time.
*/
Vector (const TrilinosWrappers::Vector &v);
#endif
/**
* Constructor. Set dimension to
* @p n and initialize all
* elements with zero.
*
* The constructor is made
* explicit to avoid accidents
* like this:
* <tt>v=0;</tt>. Presumably, the user
* wants to set every element of
* the vector to zero, but
* instead, what happens is this
* call:
* <tt>v=Vector@<number@>(0);</tt>,
* i.e. the vector is replaced by
* one of length zero.
*/
explicit Vector (const unsigned int n);
/**
* Initialize the vector with a
* given range of values pointed
* to by the iterators. This
* function is there in analogy
* to the @p std::vector class.
*/
template <typename InputIterator>
Vector (const InputIterator first,
const InputIterator last);
/**
* Destructor, deallocates
* memory. Made virtual to allow
* for derived classes to behave
* properly.
*/
virtual ~Vector ();
/**
* This function does nothing but is
* there for compatibility with the
* @p PETScWrappers::Vector class.
*
* For the PETSc vector wrapper class,
* thios function compresses the
* underlying representation of the PETSc
* object, i.e. flushes the buffers of
* the vector object if it has any. This
* function is necessary after writing
* into a vector element-by-element and
* before anything else can be done on
* it.
*
* However, for the implementation of
* this class, it is immaterial and thus
* an empty function.
*/
void compress () const;
/**
* Change the dimension of the vector to
* @p N. The reserved memory for this
* vector remains unchanged if possible,
* to make things faster; this may waste
* some memory, so keep this in mind.
* However, if <tt>N==0</tt> all memory is
* freed, i.e. if you want to resize the
* vector and release the memory not
* needed, you have to first call
* <tt>reinit(0)</tt> and then
* <tt>reinit(N)</tt>. This cited behaviour is
* analogous to that of the STL
* containers.
*
* If @p fast is false, the vector is
* filled by zeros. Otherwise, the
* elements are left an unspecified
* state.
*
* This function is virtual in
* order to allow for derived
* classes to handle memory
* separately.
*/
virtual void reinit (const unsigned int N,
const bool fast=false);
/**
* Change the dimension to that of the
* vector @p V. The same applies as for
* the other @p reinit function.
*
* The elements of @p V are not copied,
* i.e. this function is the same as
* calling <tt>reinit (V.size(), fast)</tt>.
*/
template <typename Number2>
void reinit (const Vector<Number2> &V,
const bool fast=false);
/**
* Swap the contents of this
* vector and the other vector
* @p v. One could do this
* operation with a temporary
* variable and copying over the
* data elements, but this
* function is significantly more
* efficient since it only swaps
* the pointers to the data of
* the two vectors and therefore
* does not need to allocate
* temporary storage and move
* data around.
*
* This function is analog to the
* the @p swap function of all C++
* standard containers. Also,
* there is a global function
* <tt>swap(u,v)</tt> that simply calls
* <tt>u.swap(v)</tt>, again in analogy
* to standard functions.
*
* This function is virtual in
* order to allow for derived
* classes to handle memory
* separately.
*/
virtual void swap (Vector<Number> &v);
/**
* Set all components of the vector to
* the given number @p s. Simply pass
* this down to the individual block
* objects, but we still need to declare
* this function to make the example
* given in the discussion about making
* the constructor explicit work.
*
* Since the semantics of assigning a
* scalar to a vector are not
* immediately clear, this operator
* should really only be used if you
* want to set the entire vector to
* zero. This allows the intuitive
* notation <tt>v=0</tt>. Assigning
* other values is deprecated and may
* be disallowed in the future.
*/
Vector<Number> & operator = (const Number s);
/**
* Copy the given vector. Resize the
* present vector if necessary.
*/
Vector<Number> & operator= (const Vector<Number> &c);
/**
* Copy the given vector. Resize the
* present vector if necessary.
*/
template <typename Number2>
Vector<Number> & operator= (const Vector<Number2> &v);
/**
* Copy operator for assigning a
* block vector to a regular
* vector.
*/
Vector<Number> & operator= (const BlockVector<Number> &v);
#ifdef DEAL_II_USE_PETSC
/**
* Another copy operator: copy the
* values from a sequential PETSc
* wrapper vector class. This
* operator is only available if
* PETSc was detected during
* configuration time.
*/
Vector<Number> &
operator = (const PETScWrappers::Vector &v);
/**
* Another copy operator: copy the
* values from a parallel PETSc
* wrapper vector class. This
* operator is only available if
* PETSc was detected during
* configuration time.
*
* Note that due to the
* communication model used in MPI,
* this operation can only succeed
* if all processes do it at the
* same time. I.e., it is not
* possible for only one process to
* obtain a copy of a parallel
* vector while the other jobs do
* something else.
*/
Vector<Number> &
operator = (const PETScWrappers::MPI::Vector &v);
#endif
#ifdef DEAL_II_USE_TRILINOS
/**
* Another copy operator: copy
* the values from a (sequential
* or parallel, depending on the
* underlying compiler) Trilinos
* wrapper vector class. This
* operator is only available if
* Trilinos was detected during
* configuration time.
*
* Note that due to the
* communication model used in MPI,
* this operation can only succeed
* if all processes do it at the
* same time. I.e., it is not
* possible for only one process to
* obtain a copy of a parallel
* vector while the other jobs do
* something else.
*/
Vector<Number> &
operator = (const TrilinosWrappers::MPI::Vector &v);
/**
* Another copy operator: copy the
* values from a sequential
* Trilinos wrapper vector
* class. This operator is only
* available if Trilinos was
* detected during configuration
* time.
*/
Vector<Number> &
operator = (const TrilinosWrappers::Vector &v);
#endif
/**
* Test for equality. This function
* assumes that the present vector
* and the one to compare with have
* the same size already, since
* comparing vectors of different
* sizes makes not much sense
* anyway.
*/
template <typename Number2>
bool operator == (const Vector<Number2> &v) const;
/**
* Test for inequality. This function
* assumes that the present vector and
* the one to compare with have the same
* size already, since comparing vectors
* of different sizes makes not much
* sense anyway.
*/
template <typename Number2>
bool operator != (const Vector<Number2> &v) const;
/**
* Return the scalar product of
* two vectors. The return type
* is the underlying type of
* @p this vector, so the return
* type and the accuracy with
* which it the result is
* computed depend on the order
* of the arguments of this
* vector.
*
* For complex vectors, the
* scalar product is implemented
* as $\left<v,w\right>=\sum_i
* v_i \bar{w_i}$.
*/
template <typename Number2>
Number operator * (const Vector<Number2> &V) const;
/**
* Return square of the $l_2$-norm.
*/
real_type norm_sqr () const;
/**
* Mean value of the elements of
* this vector.
*/
Number mean_value () const;
/**
* $l_1$-norm of the vector.
* The sum of the absolute values.
*/
real_type l1_norm () const;
/**
* $l_2$-norm of the vector. The
* square root of the sum of the
* squares of the elements.
*/
real_type l2_norm () const;
/**
* $l_p$-norm of the vector. The
* pth root of the sum of the pth
* powers of the absolute values
* of the elements.
*/
real_type lp_norm (const real_type p) const;
/**
* Maximum absolute value of the
* elements.
*/
real_type linfty_norm () const;
/**
* Return dimension of the vector.
*/
unsigned int size () const;
/**
* Return whether the vector contains only
* elements with value zero. This function
* is mainly for internal consistency
* checks and should seldomly be used when
* not in debug mode since it uses quite
* some time.
*/
bool all_zero () const;
/**
* Return @p true if the vector has no
* negative entries, i.e. all entries are
* zero or positive. This function is
* used, for example, to check whether
* refinement indicators are really all
* positive (or zero).
*
* The function obviously only makes
* sense if the template argument of this
* class is a real type. If it is a
* complex type, then an exception is
* thrown.
*/
bool is_non_negative () const;
/**
* Make the @p Vector class a bit like
* the <tt>vector<></tt> class of the C++
* standard library by returning
* iterators to the start and end of the
* elements of this vector.
*/
iterator begin ();
/**
* Return constant iterator to the start of
* the vectors.
*/
const_iterator begin () const;
/**
* Return an iterator pointing to the
* element past the end of the array.
*/
iterator end ();
/**
* Return a constant iterator pointing to
* the element past the end of the array.
*/
const_iterator end () const;
//@}
/**
* @name 2: Data-Access
*/
//@{
/**
* Access the value of the @p ith
* component.
*/
Number operator() (const unsigned int i) const;
/**
* Access the @p ith component
* as a writeable reference.
*/
Number& operator() (const unsigned int i);
//@}
/**
* @name 3: Modification of vectors
*/
//@{
/**
* Add the given vector to the present
* one.
*/
Vector<Number> & operator += (const Vector<Number> &V);
/**
* Subtract the given vector from the
* present one.
*/
Vector<Number> & operator -= (const Vector<Number> &V);
/**
* A collective add operation:
* This funnction adds a whole
* set of values stored in @p
* values to the vector
* components specified by @p
* indices.
*/
template <typename OtherNumber>
void add (const std::vector<unsigned int> &indices,
const std::vector<OtherNumber> &values);
/**
* This is a second collective
* add operation. As a
* difference, this function
* takes a deal.II vector of
* values.
*/
template <typename OtherNumber>
void add (const std::vector<unsigned int> &indices,
const Vector<OtherNumber> &values);
/**
* Take an address where
* <tt>n_elements</tt> are stored
* contiguously and add them into
* the vector. Handles all cases
* which are not covered by the
* other two <tt>add()</tt>
* functions above.
*/
template <typename OtherNumber>
void add (const unsigned int n_elements,
const unsigned int *indices,
const OtherNumber *values);
/**
* Addition of @p s to all
* components. Note that @p s is a
* scalar and not a vector.
*/
void add (const Number s);
/**
* Simple vector addition, equal to the
* <tt>operator +=</tt>.
*/
void add (const Vector<Number> &V);
/**
* Simple addition of a multiple of a
* vector, i.e. <tt>*this += a*V</tt>.
*/
void add (const Number a, const Vector<Number> &V);
/**
* Multiple addition of scaled vectors,
* i.e. <tt>*this += a*V+b*W</tt>.
*/
void add (const Number a, const Vector<Number> &V,
const Number b, const Vector<Number> &W);
/**
* Scaling and simple vector addition,
* i.e.
* <tt>*this = s*(*this)+V</tt>.
*/
void sadd (const Number s,
const Vector<Number> &V);
/**
* Scaling and simple addition, i.e.
* <tt>*this = s*(*this)+a*V</tt>.
*/
void sadd (const Number s,
const Number a,
const Vector<Number> &V);
/**
* Scaling and multiple addition.
*/
void sadd (const Number s,
const Number a,
const Vector<Number> &V,
const Number b,
const Vector<Number> &W);
/**
* Scaling and multiple addition.
* <tt>*this = s*(*this)+a*V + b*W + c*X</tt>.
*/
void sadd (const Number s,
const Number a,
const Vector<Number> &V,
const Number b,
const Vector<Number> &W,
const Number c,
const Vector<Number> &X);
/**
* Scale each element of the
* vector by the given factor.
*
* This function is deprecated
* and will be removed in a
* future version. Use
* <tt>operator *=</tt> and
* <tt>operator /=</tt> instead.
*/
void scale (const Number factor);
/**
* Scale each element of the
* vector by a constant
* value.
*/
Vector<Number> & operator *= (const Number factor);
/**
* Scale each element of the
* vector by the inverse of the
* given value.
*/
Vector<Number> & operator /= (const Number factor);
/**
* Scale each element of this
* vector by the corresponding
* element in the argument. This
* function is mostly meant to
* simulate multiplication (and
* immediate re-assignment) by a
* diagonal scaling matrix.
*/
void scale (const Vector<Number> &scaling_factors);
/**
* Scale each element of this
* vector by the corresponding
* element in the argument. This
* function is mostly meant to
* simulate multiplication (and
* immediate re-assignment) by a
* diagonal scaling matrix.
*/
template <typename Number2>
void scale (const Vector<Number2> &scaling_factors);
/**
* Assignment <tt>*this = a*u</tt>.
*/
void equ (const Number a, const Vector<Number>& u);
/**
* Assignment <tt>*this = a*u</tt>.
*/
template <typename Number2>
void equ (const Number a, const Vector<Number2>& u);
/**
* Assignment <tt>*this = a*u + b*v</tt>.
*/
void equ (const Number a, const Vector<Number>& u,
const Number b, const Vector<Number>& v);
/**
* Assignment <tt>*this = a*u + b*v + b*w</tt>.
*/
void equ (const Number a, const Vector<Number>& u,
const Number b, const Vector<Number>& v,
const Number c, const Vector<Number>& w);
/**
* Compute the elementwise ratio of the
* two given vectors, that is let
* <tt>this[i] = a[i]/b[i]</tt>. This is
* useful for example if you want to
* compute the cellwise ratio of true to
* estimated error.
*
* This vector is appropriately
* scaled to hold the result.
*
* If any of the <tt>b[i]</tt> is
* zero, the result is
* undefined. No attempt is made
* to catch such situations.
*/
void ratio (const Vector<Number> &a,
const Vector<Number> &b);
//@}
/**
* @name 5: Mixed stuff
*/
//@{
/**
* Output of vector in user-defined
* format. For complex-valued vectors,
* the format should include specifiers
* for both the real and imaginary
* parts.
*/
void print (const char* format = 0) const;
/**
* Print to a
* stream. @p precision denotes
* the desired precision with
* which values shall be printed,
* @p scientific whether
* scientific notation shall be
* used. If @p across is
* @p true then the vector is
* printed in a line, while if
* @p false then the elements
* are printed on a separate line
* each.
*/
void print (std::ostream &out,
const unsigned int precision = 3,
const bool scientific = true,
const bool across = true) const;
/**
* Write the vector en bloc to a
* file. This is done in a binary
* mode, so the output is neither
* readable by humans nor
* (probably) by other computers
* using a different operating
* system or number format.
*/
void block_write (std::ostream &out) const;
/**
* Read a vector en block from a
* file. This is done using the
* inverse operations to the
* above function, so it is
* reasonably fast because the
* bitstream is not interpreted.
*
* The vector is resized if
* necessary.
*
* A primitive form of error
* checking is performed which
* will recognize the bluntest
* attempts to interpret some
* data as a vector stored
* bitwise to a file, but not
* more.
*/
void block_read (std::istream &in);
/**
* Determine an estimate for the
* memory consumption (in bytes)
* of this object.
*/
unsigned int memory_consumption () const;
//@}
protected:
/**
* Dimension. Actual number of
* components contained in the
* vector. Get this number by
* calling <tt>size()</tt>.
*/
unsigned int vec_size;
/**
* Amount of memory actually
* reserved for this vector. This
* number may be greater than
* @p vec_size if a @p reinit was
* called with less memory
* requirements than the vector
* needed last time. At present
* @p reinit does not free
* memory when the number of
* needed elements is reduced.
*/
unsigned int max_vec_size;
/**
* Pointer to the array of
* elements of this vector.
*/
Number *val;
/*
* Make all other vector types
* friends.
*/
template <typename Number2> friend class Vector;
/*
* LAPACK matrices need access to
* the data.
*/
friend class LAPACKFullMatrix<Number>;
/*
* VectorView will access the
* pointer.
*/
friend class VectorView<Number>;
};
/*@}*/
/*----------------------- Inline functions ----------------------------------*/
#ifndef DOXYGEN
template <typename Number>
inline
Vector<Number>::Vector ()
:
vec_size(0),
max_vec_size(0),
val(0)
{}
template <typename Number>
template <typename InputIterator>
Vector<Number>::Vector (const InputIterator first, const InputIterator last)
:
vec_size (0),
max_vec_size (0),
val (0)
{
// allocate memory. do not
// initialize it, as we will copy
// over to it in a second
reinit (std::distance (first, last), true);
std::copy (first, last, begin());
}
template <typename Number>
inline
Vector<Number>::Vector (const unsigned int n)
:
vec_size(0),
max_vec_size(0),
val(0)
{
reinit (n, false);
}
template <typename Number>
inline
Vector<Number>::~Vector ()
{
if (val)
{
delete[] val;
val=0;
}
}
template <typename Number>
inline
void Vector<Number>::reinit (const unsigned int n, const bool fast)
{
if (n==0)
{
if (val) delete[] val;
val = 0;
max_vec_size = vec_size = 0;
return;
};
if (n>max_vec_size)
{
if (val) delete[] val;
val = new value_type[n];
Assert (val != 0, ExcOutOfMemory());
max_vec_size = n;
};
vec_size = n;
if (fast == false)
*this = static_cast<Number>(0);
}
namespace internal
{
namespace Vector
{
template<typename T>
void set_subrange (const T s,
const unsigned int begin,
const unsigned int end,
dealii::Vector<T> &dst)
{
if (s == T())
std::memset ((dst.begin()+begin),0,(end-begin)*sizeof(T));
else
std::fill (&*(dst.begin()+begin), &*(dst.begin()+end), s);
}
template<typename T>
void copy_subrange (const dealii::Vector<T>&src,
const unsigned int begin,
const unsigned int end,
dealii::Vector<T> &dst)
{
memcpy(&*(dst.begin()+begin), &*(src.begin()+begin),
(end-begin)*sizeof(T));
}
template<typename T, typename U>
void copy_subrange_ext (const dealii::Vector<T>&src,
const unsigned int begin,
const unsigned int end,
dealii::Vector<U> &dst)
{
const T* q = src.begin()+begin;
const T* const end_q = src.begin()+end;
U* p = dst.begin()+begin;
for (; q!=end_q; ++q, ++p)
*p = *q;
}
}
}
template <typename Number>
inline
Vector<Number> & Vector<Number>::operator = (const Number s)
{
Assert (numbers::is_finite(s),
ExcMessage("The given value is not finite but either infinite or "
"Not A Number (NaN)"));
if (s != Number())
Assert (vec_size!=0, ExcEmptyObject());
if (vec_size>internal::Vector::minimum_parallel_grain_size)
parallel::apply_to_subranges (0U, vec_size,
std_cxx1x::bind(&internal::Vector::template
set_subrange<Number>,
s, _1, _2, std_cxx1x::ref(*this)),
internal::Vector::minimum_parallel_grain_size);
else if (vec_size > 0)
internal::Vector::set_subrange<Number>(s, 0U, vec_size, *this);
return *this;
}
#ifdef DEAL_II_BOOST_BIND_COMPILER_BUG
template <>
inline
Vector<std::complex<float> > &
Vector<std::complex<float> >::operator = (const std::complex<float> s)
{
Assert (numbers::is_finite(s),
ExcMessage("The given value is not finite but either infinite or "
"Not A Number (NaN)"));
if (s != std::complex<float>())
Assert (vec_size!=0, ExcEmptyObject());
if (vec_size!=0)
std::fill (begin(), end(), s);
return *this;
}
#endif
template <typename Number>
inline
Vector<Number> &
Vector<Number>::operator = (const Vector<Number>& v)
{
if (v.vec_size != vec_size)
reinit (v.vec_size, true);
if (vec_size>internal::Vector::minimum_parallel_grain_size)
parallel::apply_to_subranges (0U, vec_size,
std_cxx1x::bind(&internal::Vector::template
copy_subrange<Number>,
std_cxx1x::cref(v), _1, _2,
std_cxx1x::ref(*this)),
internal::Vector::minimum_parallel_grain_size);
else if (vec_size > 0)
internal::Vector::copy_subrange<Number>(v, 0U, vec_size, *this);
return *this;
}
template <typename Number>
template <typename Number2>
inline
Vector<Number> &
Vector<Number>::operator = (const Vector<Number2>& v)
{
if (v.vec_size != vec_size)
reinit (v.vec_size, true);
if (vec_size>internal::Vector::minimum_parallel_grain_size)
parallel::apply_to_subranges (0U, vec_size,
std_cxx1x::bind(&internal::Vector::template
copy_subrange_ext<Number2,Number>,
std_cxx1x::cref(v), _1, _2,
std_cxx1x::ref(*this)),
internal::Vector::minimum_parallel_grain_size);
else if (vec_size > 0)
internal::Vector::copy_subrange_ext<Number2,Number>(v, 0U, vec_size, *this);
return *this;
}
template <typename Number>
inline
unsigned int Vector<Number>::size () const
{
return vec_size;
}
template <typename Number>
inline
typename Vector<Number>::iterator
Vector<Number>::begin ()
{
return &val[0];
}
template <typename Number>
inline
typename Vector<Number>::const_iterator
Vector<Number>::begin () const
{
return &val[0];
}
template <typename Number>
inline
typename Vector<Number>::iterator
Vector<Number>::end ()
{
return &val[vec_size];
}
template <typename Number>
inline
typename Vector<Number>::const_iterator
Vector<Number>::end () const
{
return &val[vec_size];
}
template <typename Number>
inline
Number Vector<Number>::operator() (const unsigned int i) const
{
Assert (i<vec_size, ExcIndexRange(i,0,vec_size));
return val[i];
}
template <typename Number>
inline
Number& Vector<Number>::operator() (const unsigned int i)
{
Assert (i<vec_size, ExcIndexRange(i,0,vec_size));
return val[i];
}
template <typename Number>
inline
Vector<Number> & Vector<Number>::operator *= (const Number factor)
{
Assert (numbers::is_finite(factor),
ExcMessage("The given value is not finite but either infinite or Not A Number (NaN)"));
scale (factor);
return *this;
}
template <typename Number>
inline
Vector<Number> &
Vector<Number>::operator /= (const Number factor)
{
Assert (numbers::is_finite(factor),
ExcMessage("The given value is not finite but either infinite or Not A Number (NaN)"));
Assert (factor != Number(0.), ExcZero() );
this->operator *= (Number(1.)/factor);
return *this;
}
template <typename Number>
inline
void
Vector<Number>::scale (const Number factor)
{
Assert (numbers::is_finite(factor),
ExcMessage("The given value is not finite but either infinite or Not A Number (NaN)"));
Assert (vec_size!=0, ExcEmptyObject());
parallel::transform (val,
val+vec_size,
val,
(factor*boost::lambda::_1),
internal::Vector::minimum_parallel_grain_size);
}
template <typename Number>
template <typename OtherNumber>
inline
void
Vector<Number>::add (const std::vector<unsigned int> &indices,
const std::vector<OtherNumber> &values)
{
Assert (indices.size() == values.size(),
ExcDimensionMismatch(indices.size(), values.size()));
add (indices.size(), &indices[0], &values[0]);
}
template <typename Number>
template <typename OtherNumber>
inline
void
Vector<Number>::add (const std::vector<unsigned int> &indices,
const Vector<OtherNumber> &values)
{
Assert (indices.size() == values.size(),
ExcDimensionMismatch(indices.size(), values.size()));
add (indices.size(), &indices[0], values.val);
}
template <typename Number>
template <typename OtherNumber>
inline
void
Vector<Number>::add (const unsigned int n_indices,
const unsigned int *indices,
const OtherNumber *values)
{
for (unsigned int i=0; i<n_indices; ++i)
{
Assert (indices[i] < vec_size, ExcIndexRange(indices[i],0,vec_size));
Assert (numbers::is_finite(values[i]),
ExcMessage("The given value is not finite but either infinite or Not A Number (NaN)"));
val[indices[i]] += values[i];
}
}
template <typename Number>
inline
void
Vector<Number>::add (const Number a,
const Vector<Number>& v)
{
Assert (numbers::is_finite(a),
ExcMessage("The given value is not finite but either infinite or Not A Number (NaN)"));
Assert (vec_size!=0, ExcEmptyObject());
Assert (vec_size == v.vec_size, ExcDimensionMismatch(vec_size, v.vec_size));
parallel::transform (val,
val+vec_size,
v.val,
val,
(boost::lambda::_1 + a*boost::lambda::_2),
internal::Vector::minimum_parallel_grain_size);
}
template <typename Number>
inline
void
Vector<Number>::sadd (const Number x,
const Number a,
const Vector<Number>& v)
{
Assert (numbers::is_finite(x),
ExcMessage("The given value is not finite but either infinite or Not A Number (NaN)"));
Assert (numbers::is_finite(a),
ExcMessage("The given value is not finite but either infinite or Not A Number (NaN)"));
Assert (vec_size!=0, ExcEmptyObject());
Assert (vec_size == v.vec_size, ExcDimensionMismatch(vec_size, v.vec_size));
parallel::transform (val,
val+vec_size,
v.val,
val,
(x*boost::lambda::_1 + a*boost::lambda::_2),
internal::Vector::minimum_parallel_grain_size);
}
template <typename Number>
template <typename Number2>
inline
bool
Vector<Number>::operator != (const Vector<Number2>& v) const
{
return ! (*this == v);
}
template <typename Number>
inline
void
Vector<Number>::compress () const
{}
// Moved from vector.templates.h as an inline function by Luca Heltai
// on 2009/04/12 to prevent strange compiling errors, after making
// swap virtual.
template <typename Number>
inline
void
Vector<Number>::swap (Vector<Number> &v)
{
std::swap (vec_size, v.vec_size);
std::swap (max_vec_size, v.max_vec_size);
std::swap (val, v.val);
}
#endif
/*! @addtogroup Vectors
*@{
*/
/**
* Global function @p swap which overloads the default implementation
* of the C++ standard library which uses a temporary object. The
* function simply exchanges the data of the two vectors.
*
* @relates Vector
* @author Wolfgang Bangerth, 2000
*/
template <typename Number>
inline
void swap (Vector<Number> &u, Vector<Number> &v)
{
u.swap (v);
}
/*@}*/
DEAL_II_NAMESPACE_CLOSE
#endif
|