ARTS  2.3.626
Vector Class Reference

The Vector class. More...

#include <matpackI.h>

Inheritance diagram for Vector:
VectorView ConstVectorView MakeVector

Public Member Functions

 Vector ()
 Default constructor. More...
 
 Vector (Index n)
 Constructor setting size. More...
 
 Vector (Index n, Numeric fill)
 Constructor setting size and filling with constant value. More...
 
 Vector (Numeric start, Index extent, Numeric stride)
 Constructor filling with values. More...
 
 Vector (const ConstVectorView &v)
 Copy constructor from VectorView. More...
 
 Vector (const Vector &v)
 Copy constructor from Vector. More...
 
 Vector (const std::vector< Numeric > &)
 Converting constructor from std::vector<Numeric>. More...
 
Vectoroperator= (Vector v)
 Assignment from another Vector. More...
 
Vectoroperator= (const Array< Numeric > &v)
 Assignment operator from Array<Numeric>. More...
 
Vectoroperator= (Numeric x)
 Assignment operator from scalar. More...
 
void resize (Index n)
 Assignment operator from VectorView. More...
 
virtual ~Vector ()
 Destructor for Vector. More...
 
- Public Member Functions inherited from VectorView
 VectorView (const Vector &)
 Bail out immediately if somebody tries to create a VectorView from a const Vector. More...
 
 VectorView (Vector &v)
 Create VectorView from a Vector. More...
 
Numeric operator[] (Index n) const
 Plain const index operator. More...
 
Numeric get (Index n) const
 Get element implementation without assertions. More...
 
ConstVectorView operator[] (const Range &r) const
 Const index operator for subrange. More...
 
Numericoperator[] (Index n)
 Plain Index operator. More...
 
Numericget (Index n)
 Get element implementation without assertions. More...
 
VectorView operator[] (const Range &r)
 Index operator for subrange. More...
 
ConstIterator1D begin () const
 Return const iterator to first element. More...
 
ConstIterator1D end () const
 Return const iterator behind last element. More...
 
Iterator1D begin ()
 Return iterator to first element. More...
 
Iterator1D end ()
 Return iterator behind last element. More...
 
VectorViewoperator= (const ConstVectorView &v)
 Assignment operator. More...
 
VectorViewoperator= (const VectorView &v)
 Assignment from VectorView to VectorView. More...
 
VectorViewoperator= (const Vector &v)
 Assignment from Vector. More...
 
VectorViewoperator= (const Array< Numeric > &v)
 Assignment operator from Array<Numeric>. More...
 
VectorViewoperator= (Numeric x)
 Assigning a scalar to a VectorView will set all elements to this value. More...
 
VectorView operator*= (Numeric x)
 Multiplication by scalar. More...
 
VectorView operator/= (Numeric x)
 Division by scalar. More...
 
VectorView operator+= (Numeric x)
 Addition of scalar. More...
 
VectorView operator-= (Numeric x)
 Subtraction of scalar. More...
 
VectorView operator*= (const ConstVectorView &x)
 Element-vise multiplication by another vector. More...
 
VectorView operator/= (const ConstVectorView &x)
 Element-vise division by another vector. More...
 
VectorView operator+= (const ConstVectorView &x)
 Element-vise addition of another vector. More...
 
VectorView operator-= (const ConstVectorView &x)
 Element-vise subtraction of another vector. More...
 
 operator MatrixView ()
 Conversion to 1 column matrix. More...
 
const Numericget_c_array () const
 Conversion to plain C-array. More...
 
Numericget_c_array ()
 Conversion to plain C-array. More...
 
virtual ~VectorView ()
 Destructor. More...
 
 VectorView (Numeric &a)
 A special constructor, which allows to make a VectorView from a scalar. More...
 
- Public Member Functions inherited from ConstVectorView
bool empty () const
 Returns true if variable size is zero. More...
 
Index nelem () const
 Returns the number of elements. More...
 
Numeric sum () const
 The sum of all elements of a Vector. More...
 
Numeric operator[] (Index n) const
 Plain const index operator. More...
 
Numeric get (Index n) const
 Get element implementation without assertions. More...
 
ConstVectorView operator[] (const Range &r) const
 Const index operator for subrange. More...
 
ConstIterator1D begin () const
 Return const iterator to first element. More...
 
ConstIterator1D end () const
 Return const iterator behind last element. More...
 
 operator ConstMatrixView () const
 Conversion to const 1 column matrix. More...
 
virtual ~ConstVectorView ()
 Destructor. More...
 
 ConstVectorView (const Numeric &a)
 A special constructor, which allows to make a ConstVectorView from a scalar. More...
 

Friends

void swap (Vector &v1, Vector &v2)
 Swaps two objects. More...
 

Additional Inherited Members

- Public Types inherited from VectorView
typedef Iterator1D iterator
 
- Public Types inherited from ConstVectorView
typedef ConstIterator1D const_iterator
 
- Protected Member Functions inherited from VectorView
 VectorView ()
 Default constructor. More...
 
 VectorView (Numeric *data, const Range &range)
 Explicit constructor. More...
 
 VectorView (Numeric *data, const Range &p, const Range &n)
 Recursive constructor. More...
 
- Protected Member Functions inherited from ConstVectorView
 ConstVectorView ()
 Default constructor. More...
 
 ConstVectorView (Numeric *data, const Range &range)
 Explicit constructor. More...
 
 ConstVectorView (Numeric *data, const Range &p, const Range &n)
 Recursive constructor. More...
 
- Protected Attributes inherited from ConstVectorView
Range mrange
 The range of mdata that is actually used. More...
 
Numericmdata
 Pointer to the plain C array that holds the data. More...
 

Detailed Description

The Vector class.

This is a subvector that also allocates storage automatically, and deallocates it when it is destroyed. We take all the functionality from VectorView. Additionally defined in this class are:

  1. Constructors and destructors (allocating memory).
  2. Assignment operator
  3. Assignment operator from scalar.
  4. Resize function.

Definition at line 575 of file matpackI.h.

Constructor & Destructor Documentation

Vector::Vector ( )

Default constructor.

Definition at line 647 of file matpackI.cc.

Vector::Vector ( Index  n)
explicit

Constructor setting size.

Definition at line 653 of file matpackI.cc.

Vector::Vector ( Index  n,
Numeric  fill 
)

Constructor setting size and filling with constant value.

Definition at line 661 of file matpackI.cc.

References ConstVectorView::mdata.

Vector::Vector ( Numeric  start,
Index  extent,
Numeric  stride 
)

Constructor filling with values.

Examples:

Vector v(1,5,1); // 1, 2, 3, 4, 5 Vector v(1,5,.5); // 1, 1.5, 2, 2.5, 3 Vector v(5,5,-1); // 5, 4, 3, 2, 1

Definition at line 680 of file matpackI.cc.

References VectorView::begin(), and VectorView::end().

Vector::Vector ( const ConstVectorView v)

Copy constructor from VectorView.

This automatically sets the size and copies the data. The vector created will have start zero and stride 1, independent on how these parameters are set for the original. So, what is copied is the data, not the shape of the selection.

Definition at line 700 of file matpackI.cc.

References ConstVectorView::begin(), VectorView::begin(), copy(), and ConstVectorView::end().

Vector::Vector ( const Vector v)

Copy constructor from Vector.

This is important to override the automatically generated shallow constructor. We want deep copies!

Definition at line 709 of file matpackI.cc.

References VectorView::begin(), copy(), and VectorView::end().

Vector::Vector ( const std::vector< Numeric > &  v)

Converting constructor from std::vector<Numeric>.

Definition at line 717 of file matpackI.cc.

References VectorView::begin(), and VectorView::end().

Vector::~Vector ( )
virtual

Destructor for Vector.

This is important, since Vector uses new to allocate storage.

Definition at line 830 of file matpackI.cc.

References ConstVectorView::mdata.

Member Function Documentation

Vector & Vector::operator= ( Vector  v)

Assignment from another Vector.

While dimensions of VectorViews can not be adjusted, dimensions of Vectors can be adjusted. Hence, the behavior of the assignment operator is different.

In this case the size of the target is automatically adjusted. This is important, so that structures containing Vectors are copied correctly.

This is a deviation from the old ARTS paradigm that sizes must match exactly before copying!

Note: It is sufficient to have only this one version of the assignment (Vector = Vector). It implicitly covers the cases Vector=VectorView, etc, because there is a default constructor for Vector from VectorView. (See C++ Primer Plus, page 571ff.)

Parameters
vThe other vector to copy to this one.
Returns
This vector, by tradition.
Author
Stefan Buehler
Date
2002-12-19

Definition at line 754 of file matpackI.cc.

References swap.

Vector & Vector::operator= ( const Array< Numeric > &  x)

Assignment operator from Array<Numeric>.

This copies the data from a Array<Numeric> to this VectorView. The size is adjusted automatically.

Array<Numeric> can be useful to collect things in, because there is a .push_back method for it. Then, after collecting we usually have to transfer the content to a Vector. With this assignment operator that's easy.

Parameters
xThe array to assign to this.
Returns
This vector, by tradition.
Author
Stefan Buehler
Date
2002-12-19

Definition at line 777 of file matpackI.cc.

References Array< base >::nelem(), VectorView::operator=(), and resize().

Vector & Vector::operator= ( Numeric  x)

Assignment operator from scalar.

Assignment operators are not inherited.

Definition at line 786 of file matpackI.cc.

References VectorView::operator=().

void Vector::resize ( Index  n)

Assignment operator from VectorView.

Assignment operators are not inherited. Resize function. If the size is already correct this function does nothing. All data is lost after resizing! The new Vector is not initialized, so it will contain random values.

Definition at line 806 of file matpackI.cc.

References ConstVectorView::mdata, Range::mextent, ConstVectorView::mrange, Range::mstart, and Range::mstride.

Referenced by abs_h2oSet(), abs_lookupCalc(), abs_lookupSetup(), abs_lookupSetupBatch(), abs_lookupSetupWide(), abs_lookupTestAccMC(), abs_n2Set(), abs_o2Set(), abs_xsec_per_speciesAddCIA(), abs_xsec_per_speciesAddConts(), AbsInputFromRteScalars(), GasAbsLookup::Adapt(), Append(), AtmosphereSet1D(), AtmosphereSet2D(), AtmosphereSet3D(), cloud_RT_surface(), cloudbox_checkedCalc(), cum_l_stepCalc(), defocusing_general_sub(), dNdD_Ar_H13(), dNdD_F07ML(), dNdD_F07TR(), dNdD_H11(), dNdD_H98(), dNdD_MGD_IWC(), dNdD_MGD_LWC(), dNdD_MH97(), dNdD_MP48(), dNdD_S2M(), dNdD_S2M_M(), do_gridcell_2d_byltest(), do_gridcell_3d(), do_gridcell_3d_byltest(), DOAngularGridsSet(), GasAbsLookup::Extract(), ExtractFromMetaSingleScatSpecies(), f_gridFromabs_linesSet(), f_gridFromGasAbsLookup(), f_gridMetMM(), fastem(), find_effective_channel_boundaries(), findZ11max(), LineMixingData::FirstOrderData2Vector(), fos(), FrequencyFromCGSAngularWavenumber(), FrequencyFromCGSKayserWavenumber(), FrequencyFromWavelength(), gaussian_response(), geo_posWherePpathPassesZref(), geompath_from_r1_to_r2(), get_iy_of_background(), get_ppath_atmvars(), get_ppath_trans(), get_ppath_trans2(), get_ppath_trans2_and_dppath_trans_dx(), get_ppath_trans_and_dppath_trans_dx(), get_refr_index_1d(), get_refr_index_2d(), get_refr_index_3d(), PartitionFunctionData::GetVectorFromData(), LineMixingData::GetVectorFromData(), PressureBroadeningData::GetVectorFromData(), iyb_calc(), iyEmissionStandard(), jacobianAddFreqShift(), jacobianAddFreqStretch(), jacobianAddPointingZa(), LineMixingData::LBLRTM_O2NonResonantData2Vector(), LineMixingData::LBLRTMData2Vector(), linreg(), linspace(), Sparse::list_elements(), los3d(), MCGeneral(), MCIPA(), MCRadar(), mirror_los(), mixer_matrix(), nca_get_data_Vector(), nca_read_from_file(), nlinspace(), nlogspace(), operator=(), opt_prop_sptFromData(), opt_propExtract(), p_gridDensify(), p_gridFromGasAbsLookup(), p_gridRefine(), ArtsParser::parse_numvector(), ArtsParser::parse_numvector_from_string(), pha_mat_singleExtract(), pha_mat_sptFromData(), pndFromdNdD(), polynomial_basis_func(), ppath_init_structure(), propmat_clearskyAddZeemanFromPreCalc(), CIARecord::ReadFromCIA(), readppdata(), Reduce(), refellipsoidEarth(), refellipsoidIo(), refellipsoidJupiter(), refellipsoidMars(), refellipsoidMoon(), refellipsoidSet(), refellipsoidVenus(), GriddedField1::resize(), rte_losGeometricFromRtePosToRtePos2(), rte_losSet(), rte_posSet(), ScatSpeciesMerge(), LineMixingData::SecondOrderData2Vector(), sensor_aux_vectors(), sensor_responseFrequencySwitching(), sensor_responseGenericAMSU(), sensor_responseMultiMixerBackend(), sensor_responseSimpleAMSU(), specular_losCalc(), surface_scalar_reflectivityFromGriddedField4(), surface_scalar_reflectivityFromSurface_rmatrix(), TangentPointExtract(), test1(), test45(), test_and_merge_two_channels(), test_empty(), test_insert_row(), tmatrix_random_orientation(), VectorAddScalar(), VectorCrop(), VectorExtractFromMatrix(), vectorfield2los(), VectorFlip(), VectorInsertGridPoints(), VectorMatrixMultiply(), VectorReshapeMatrix(), VectorScale(), VectorSetConstant(), VectorVectorMultiply(), VectorZtanToZa1D(), VectorZtanToZaRefr1D(), x2artsStandard(), xaStandard(), xml_parse_from_stream(), xsec_species_line_mixing_wrapper(), yApplySensorPol(), ybatchMetProfiles(), ybatchMetProfilesClear(), yCalc(), yCalcAppend(), yCloudRadar(), ySimpleSpectrometer(), and za_gridOpt().

Friends And Related Function Documentation

void swap ( Vector v1,
Vector v2 
)
friend

Swaps two objects.

Definition at line 821 of file matpackI.cc.

Referenced by operator=().


The documentation for this class was generated from the following files: