Changeset 783

Timestamp:

Mar 5, 2007, 10:45:32 PM (16 years ago)

Author:

Jari Häkkinen

Message:

Fixes #155. Added asserts to check vectors in all non-const functions since no inline functions exists anymore.

Location:

trunk/yat/utility

Files:

• vector.cc (modified) (15 diffs)
• vector.h (modified) (2 diffs)

trunk/yat/utility/vector.cc

@@ -30 +30 @@
 #include "utility.h"
 
+#include <cassert>
 #include <iostream>
 #include <sstream>
+#include <utility>
 #include <vector>
-#include <utility>
 
 namespace theplu {
@@ -211 +212 @@
   void vector::div(const vector& other)
   {
+    assert(v_); assert(other.v_);
     int status=gsl_vector_div(v_,other.v_);
     if (status)
@@ -237 +239 @@
   void vector::mul(const vector& other)
   {
+    assert(v_); assert(other.v_);
     int status=gsl_vector_mul(v_,other.v_);
     if (status)
@@ -245 +248 @@
   void vector::reverse(void)
   {
+    assert(v_);
     gsl_vector_reverse(v_);
   }
@@ -251 +255 @@
   void vector::set(const vector& vec)
   {
+    assert(v_); assert(vec.v_);
     if (gsl_vector_memcpy(v_,vec.v_))
       throw utility::GSL_error("vector::set dimension mis-match");
@@ -258 +263 @@
   void vector::set_all(const double& value)
   {
+    assert(v_);
     gsl_vector_set_all(v_,value);
   }
@@ -272 +278 @@
   void vector::swap(size_t i, size_t j)
   {
+    assert(v_);
     int status=gsl_vector_swap_elements(v_, i, j);
     if (status)
@@ -280 +287 @@
   double& vector::operator()(size_t i)
   {
+    assert(v_);
     double* d=gsl_vector_ptr(v_, i);
     if (!d)
@@ -348 +356 @@
   const vector& vector::operator+=(const vector& other)
   {
-    int status=gsl_vector_add(v_,other. v_);
+    assert(v_);
+    int status=gsl_vector_add(v_, other.v_);
     if (status)
       throw utility::GSL_error(std::string("vector::add", status));
@@ -357 +366 @@
   const vector& vector::operator+=(double d)
   {
+    assert(v_);
     gsl_vector_add_constant(v_, d);
     return *this;
@@ -364 +374 @@
   const vector& vector::operator-=(const vector& other)
   {
+    assert(v_);
     int status=gsl_vector_sub(v_, other.v_);
     if (status)
@@ -373 +384 @@
   const vector& vector::operator*=(const double d)
   {
+    assert(v_);
     gsl_vector_scale(v_, d);
     return *this;
@@ -426 +438 @@
   void set_basis(vector& v, size_t i)
   {
+    assert(v.gsl_vector_p());
     gsl_vector_set_basis(v.gsl_vector_p(),i);
   }
@@ -432 +445 @@
   void sort(vector& v)
   {
+    assert(v.gsl_vector_p());
     gsl_sort_vector(v.gsl_vector_p());
   }
@@ -448 +462 @@
   void swap(vector& v, vector& w)
   {
+    assert(v.gsl_vector_p()); assert(w.gsl_vector_p());
     int status=gsl_vector_swap(v.gsl_vector_p(),w.gsl_vector_p());
     if (status)

trunk/yat/utility/vector.h

@@ -63 +63 @@
      \par
      Currently there is no restriction on how a vector is used when
-     the vector is a const view into another vector or
-     matrix. To avoid unexpected runtime errors, the programmer must
-     declare const view vectors as const in order to get compile time
-     diagnostics about improper use of a const view vector object. An
-     example of improper use of a const view vector is assignment of
-     values to an element in the object. If the const view object was
-     declared const the assigment will be caught by the compiler
-     whereas it will cause a (un-catchable) runtime error. Example:
+     the vector is a const view into another vector or matrix. To
+     avoid unexpected runtime errors, the programmer must declare
+     const view vectors as 'const' in order to get compile time
+     diagnostics about improper use of a const view vector object. If
+     'const' is not used and the const view vector is used erroneously
+     (such as on the left hand side in assignments), the compiler will
+     not catch the error and runtime error will occur. assert(3) is
+     used to catch the runtime error during development. Example on
+     bad and proper use of const view vectors:
      @code
   const vector vm(13,1.0);
   vector v1(vm,2,4);       // bad code! not const!
   v1(0)=-123;              // accepted by compiler, runtime abort will occur
+                           // or catched by assert depending on compiler flags
   const vector v2(vm,2,4); // proper code
   v2(0)=-123;              // not acceptable for the compiler
@@ -415 +417 @@
     gsl_vector_const_view* view_const_;
     // proxy_v_ is used to access the proper underlying v_ or v_const_
-    // in all const member functions.
+    // in all const member functions. It is not used by design for
+    // non-const vector functions and operators. This is to make sure
+    // that runtime errors occur if a const vector is used in an
+    // inappropriate manner such as on left hand side in assignment
+    // (remember, v_ is null for const vector views).
     const gsl_vector* proxy_v_;
   };