MPQC 2.3.1
local.h
1//
2// local.h
3//
4// Copyright (C) 1996 Limit Point Systems, Inc.
5//
6// Author: Curtis Janssen <cljanss@limitpt.com>
7// Maintainer: LPS
8//
9// This file is part of the SC Toolkit.
10//
11// The SC Toolkit is free software; you can redistribute it and/or modify
12// it under the terms of the GNU Library General Public License as published by
13// the Free Software Foundation; either version 2, or (at your option)
14// any later version.
15//
16// The SC Toolkit is distributed in the hope that it will be useful,
17// but WITHOUT ANY WARRANTY; without even the implied warranty of
18// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19// GNU Library General Public License for more details.
20//
21// You should have received a copy of the GNU Library General Public License
22// along with the SC Toolkit; see the file COPYING.LIB. If not, write to
23// the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24//
25// The U.S. Government is granted a limited license as per AL 91-7.
26//
27
28#ifdef __GNUC__
29#pragma interface
30#endif
31
32#ifndef _math_scmat_local_h
33#define _math_scmat_local_h
34
35#include <math/scmat/block.h>
36#include <math/scmat/matrix.h>
37#include <math/scmat/abstract.h>
38
39namespace sc {
40
41class LocalSCMatrixKit;
42class LocalSCVector;
43class LocalSCMatrix;
44class LocalSymmSCMatrix;
45class LocalDiagSCMatrix;
46
50 public:
55 SymmSCMatrix* symmmatrix(const RefSCDimension&);
56 DiagSCMatrix* diagmatrix(const RefSCDimension&);
57 SCVector* vector(const RefSCDimension&);
58};
59
60class LocalSCVector: public SCVector {
61 friend class LocalSCMatrix;
62 friend class LocalSymmSCMatrix;
63 friend class LocalDiagSCMatrix;
64 private:
66
67 void resize(int);
68 public:
72 void assign_val(double);
73 void assign_v(SCVector*);
74 void assign_p(const double*);
75
76 void set_element(int,double);
77 void accumulate_element(int,double);
78 double get_element(int) const;
79 void accumulate_product_sv(SymmSCMatrix*,SCVector*);
80 void accumulate_product_rv(SCMatrix*,SCVector*);
81 void accumulate(const SCVector*);
82 void accumulate(const SCMatrix*);
85 void element_op(const Ref<SCElementOp2>&,
86 SCVector*);
87 void element_op(const Ref<SCElementOp3>&,
89 void vprint(const char* title=0,
90 std::ostream& out=ExEnv::out0(), int =10) const;
91
92 // return a pointer to the data for fast access
93 double *get_data();
94
95 Ref<SCMatrixSubblockIter> local_blocks(SCMatrixSubblockIter::Access);
96 Ref<SCMatrixSubblockIter> all_blocks(SCMatrixSubblockIter::Access);
97};
98
99class LocalSCMatrix: public SCMatrix {
100 friend class LocalSymmSCMatrix;
101 friend class LocalDiagSCMatrix;
102 friend class LocalSCVector;
103 private:
105 double** rows;
106 private:
107 // utility functions
108 int compute_offset(int,int) const;
109 void resize(int,int);
110 public:
114
115 // implementations and overrides of virtual functions
116 void assign_val(double);
117 double get_element(int,int) const;
118 void set_element(int,int,double);
119 void accumulate_element(int,int,double);
120 SCMatrix * get_subblock(int,int,int,int);
121 void assign_subblock(SCMatrix*, int,int,int,int,int=0,int=0);
122 void accumulate_subblock(SCMatrix*, int,int,int,int,int=0,int=0);
124 SCVector * get_column(int i);
125 void assign_row(SCVector *v, int i);
126 void assign_column(SCVector *v, int i);
127 void accumulate_row(SCVector *v, int i);
128 void accumulate_column(SCVector *v, int i);
130 void accumulate_product_rr(SCMatrix*,SCMatrix*);
131 void accumulate_product_rs(SCMatrix*,SymmSCMatrix*);
132 void accumulate_product_rd(SCMatrix*,DiagSCMatrix*);
133 void accumulate(const SCMatrix*);
134 void accumulate(const SymmSCMatrix*);
135 void accumulate(const DiagSCMatrix*);
136 void accumulate(const SCVector*);
138 double invert_this();
140 double solve_this(SCVector*);
141 double determ_this();
142 double trace();
144 int schmidt_orthog_tol(SymmSCMatrix*, double tol, double *res=0);
146 void element_op(const Ref<SCElementOp2>&,
147 SCMatrix*);
148 void element_op(const Ref<SCElementOp3>&,
150 void vprint(const char* title=0,
151 std::ostream& out=ExEnv::out0(), int =10) const;
152
153 // return a pointer to the data for fast access
154 double *get_data();
155 double **get_rows();
156
157 Ref<SCMatrixSubblockIter> local_blocks(SCMatrixSubblockIter::Access);
158 Ref<SCMatrixSubblockIter> all_blocks(SCMatrixSubblockIter::Access);
159};
160
162 friend class LocalSCMatrix;
163 friend class LocalDiagSCMatrix;
164 friend class LocalSCVector;
165 private:
167 double** rows;
168 private:
169 // utility functions
170 int compute_offset(int,int) const;
171 void resize(int n);
172 public:
175
176 // implementations and overrides of virtual functions
177 double get_element(int,int) const;
178 void set_element(int,int,double);
179 void accumulate_element(int,int,double);
180
181 SCMatrix * get_subblock(int,int,int,int);
182 SymmSCMatrix * get_subblock(int,int);
183 void assign_subblock(SCMatrix*, int,int,int,int);
184 void assign_subblock(SymmSCMatrix*, int,int);
185 void accumulate_subblock(SCMatrix*, int,int,int,int);
186 void accumulate_subblock(SymmSCMatrix*, int,int);
188 void assign_row(SCVector *v, int i);
189 void accumulate_row(SCVector *v, int i);
190
191 void accumulate_product_rr(SCMatrix*,SCMatrix*);
193 double invert_this();
194 double solve_this(SCVector*);
195 double trace();
196 double determ_this();
197 void gen_invert_this();
198
201 void accumulate_symmetric_outer_product(SCVector*);
202 void accumulate_symmetric_product(SCMatrix*);
204 void accumulate_transform(SCMatrix*,SymmSCMatrix*,
205 SCMatrix::Transform = SCMatrix::NormalTransform);
206 void accumulate_transform(SCMatrix*,DiagSCMatrix*,
207 SCMatrix::Transform = SCMatrix::NormalTransform);
208 void accumulate_transform(SymmSCMatrix*,SymmSCMatrix*);
210 void element_op(const Ref<SCElementOp2>&,
211 SymmSCMatrix*);
212 void element_op(const Ref<SCElementOp3>&,
214 void vprint(const char* title=0,
215 std::ostream& out=ExEnv::out0(), int =10) const;
216
217 // return a pointer to the data for fast access
218 double *get_data();
219 double **get_rows();
220
221 Ref<SCMatrixSubblockIter> local_blocks(SCMatrixSubblockIter::Access);
222 Ref<SCMatrixSubblockIter> all_blocks(SCMatrixSubblockIter::Access);
223};
224
226 friend class LocalSCMatrix;
227 friend class LocalSymmSCMatrix;
228 friend class LocalSCVector;
229 private:
231 void resize(int n);
232 public:
235
236 // implementations and overrides of virtual functions
237 void save_data_state(StateOut&);
238 double get_element(int) const;
239 void set_element(int,double);
240 void accumulate_element(int,double);
242 double invert_this();
243 double determ_this();
244 double trace();
246
248 void element_op(const Ref<SCElementOp2>&,
249 DiagSCMatrix*);
250 void element_op(const Ref<SCElementOp3>&,
252 void vprint(const char* title=0,
253 std::ostream& out=ExEnv::out0(), int =10) const;
254
255 // return a pointer to the data for fast access
256 double *get_data();
257
258 Ref<SCMatrixSubblockIter> local_blocks(SCMatrixSubblockIter::Access);
259 Ref<SCMatrixSubblockIter> all_blocks(SCMatrixSubblockIter::Access);
260};
261
262}
263
264#endif
265
266// Local Variables:
267// mode: c++
268// c-file-style: "CLJ"
269// End:
The SymmSCMatrix class is the abstract base class for diagonal double valued matrices.
Definition abstract.h:503
int n() const
Return the dimension.
Definition abstract.h:542
static std::ostream & out0()
Return an ostream that writes from node 0.
Definition local.h:225
double invert_this()
Invert this.
void accumulate(const DiagSCMatrix *)
Sum m into this.
Ref< SCMatrixSubblockIter > all_blocks(SCMatrixSubblockIter::Access)
Returns iterators for the all blocks used in this matrix.
void gen_invert_this()
Do a generalized inversion of this.
void element_op(const Ref< SCElementOp > &)
Perform the element operation op on each element of this.
double get_element(int) const
Return or modify an element.
double trace()
Return the trace.
Ref< SCMatrixSubblockIter > local_blocks(SCMatrixSubblockIter::Access)
Returns iterators for the local (rapidly accessible) blocks used in this matrix.
double determ_this()
Return the determinant of this. this is overwritten.
The LocalSCMatrixKit produces matrices that work in a single processor environment.
Definition local.h:49
SCMatrix * matrix(const RefSCDimension &, const RefSCDimension &)
Given the dimensions, create matrices or vectors.
Definition local.h:99
void transpose_this()
Transpose this.
void schmidt_orthog(SymmSCMatrix *, int)
Schmidt orthogonalize this.
void assign_subblock(SCMatrix *, int, int, int, int, int=0, int=0)
Assign m to a subblock of this.
SCMatrix * get_subblock(int, int, int, int)
Return a subblock of this.
Ref< SCMatrixSubblockIter > all_blocks(SCMatrixSubblockIter::Access)
Returns iterators for the all blocks used in this matrix.
double trace()
Return the trace.
void assign_val(double)
Overridden to implement to assign members.
void svd_this(SCMatrix *U, DiagSCMatrix *sigma, SCMatrix *V)
Compute the singular value decomposition for this, possibly destroying this.
void accumulate_row(SCVector *v, int i)
Sum v to a row or column of this.
double invert_this()
Invert this.
void assign_row(SCVector *v, int i)
Assign v to a row or column of this.
double get_element(int, int) const
Return or modify an element.
void element_op(const Ref< SCElementOp > &)
Perform the element operation op on each element of this.
Ref< SCMatrixSubblockIter > local_blocks(SCMatrixSubblockIter::Access)
Returns iterators for the local (rapidly accessible) blocks used in this matrix.
double determ_this()
Return the determinant of this. this is overwritten.
int schmidt_orthog_tol(SymmSCMatrix *, double tol, double *res=0)
Schmidt orthogonalize this.
SCVector * get_row(int i)
Return a row or column of this.
void accumulate_subblock(SCMatrix *, int, int, int, int, int=0, int=0)
Sum m into a subblock of this.
void accumulate_outer_product(SCVector *, SCVector *)
Sum into this the products of various vectors or matrices.
void accumulate(const SCMatrix *)
Sum m into this.
Definition local.h:60
void set_element(int, double)
Set element i to val.
void accumulate(const SCMatrix *)
Sum m into this. One of m's dimensions must be 1.
Ref< SCMatrixSubblockIter > local_blocks(SCMatrixSubblockIter::Access)
Returns iterators for the local (rapidly accessible) blocks used in this vector.
Ref< SCMatrixSubblockIter > all_blocks(SCMatrixSubblockIter::Access)
Returns iterators for the all blocks used in this vector.
void accumulate(const SCVector *)
Sum v into this.
double get_element(int) const
Return the value of element i.
void assign_val(double)
Overridden to implement the assign functions.
double scalar_product(SCVector *)
Return the dot product.
void element_op(const Ref< SCElementOp > &)
Perform the element operation op on each element of this.
void accumulate_element(int, double)
Add val to element i.
Definition local.h:161
double determ_this()
Return the determinant of this. this is overwritten.
Ref< SCMatrixSubblockIter > all_blocks(SCMatrixSubblockIter::Access)
Returns iterators for the all blocks used in this matrix.
SCMatrix * get_subblock(int, int, int, int)
Return a subblock of this.
SCVector * get_row(int i)
Return a row of this.
double invert_this()
Invert this.
Ref< SCMatrixSubblockIter > local_blocks(SCMatrixSubblockIter::Access)
Returns iterators for the local (rapidly accessible) blocks used in this matrix.
void assign_subblock(SCMatrix *, int, int, int, int)
Assign m to a subblock of this.
double scalar_product(SCVector *)
Return the scalar obtained by multiplying this on the left and right by v.
void element_op(const Ref< SCElementOp > &)
Perform the element operation op on each element of this.
void assign_row(SCVector *v, int i)
Assign v to a row of this.
void accumulate(const SymmSCMatrix *)
Sum m into this.
void diagonalize(DiagSCMatrix *, SCMatrix *)
Diagonalize this, placing the eigenvalues in d and the eigenvectors in m.
void accumulate_row(SCVector *v, int i)
Sum v to a row of this.
double get_element(int, int) const
Return or modify an element.
double trace()
Return the trace.
void accumulate_symmetric_sum(SCMatrix *)
Sum into this the products of various vectors or matrices.
void accumulate_subblock(SCMatrix *, int, int, int, int)
Sum m into a subblock of this.
The RefSCDimension class is a smart pointer to an SCDimension specialization.
Definition dim.h:156
A template class that maintains references counts.
Definition ref.h:332
The SCMatrixKit abstract class acts as a factory for producing matrices.
Definition abstract.h:58
The SCMatrix class is the abstract base class for general double valued n by m matrices.
Definition abstract.h:195
The SCVector class is the abstract base class for double valued vectors.
Definition abstract.h:97
Serializes objects that derive from SavableState.
Definition stateout.h:61
The SymmSCMatrix class is the abstract base class for symmetric double valued matrices.
Definition abstract.h:364
int n() const
Return the dimension.
Definition abstract.h:412

Generated at Thu Jul 20 2023 00:00:00 for MPQC 2.3.1 using the documentation package Doxygen 1.9.7.