File: sparse_pattern.h

package info (click to toggle)
ergo 3.8.2-1.1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 17,568 kB
  • sloc: cpp: 94,763; ansic: 17,785; sh: 10,701; makefile: 1,403; yacc: 127; lex: 116; awk: 23
file content (167 lines) | stat: -rw-r--r-- 4,763 bytes parent folder | download
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
/* Ergo, version 3.8.2, a program for linear scaling electronic structure
 * calculations.
 * Copyright (C) 2023 Elias Rudberg, Emanuel H. Rubensson, Pawel Salek,
 * and Anastasia Kruchinina.
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Primary academic reference:
 * Ergo: An open-source program for linear-scaling electronic structure
 * calculations,
 * Elias Rudberg, Emanuel H. Rubensson, Pawel Salek, and Anastasia
 * Kruchinina,
 * SoftwareX 7, 107 (2018),
 * <http://dx.doi.org/10.1016/j.softx.2018.03.005>
 * 
 * For further information about Ergo, see <http://www.ergoscf.org>.
 */

/** @file sparse_pattern.h

    @brief Class that can be used to store sparse matrix patterns.

    @author: Pawel Salek <em>responsible</em>
*/

#if !defined(_DFT_SPARSE_PATTERN_H_)
#define _DFT_SPARSE_PATTERN_H_ 1

#if !defined(BEGIN_NAMESPACE)
#define BEGIN_NAMESPACE(x) namespace x {
#define END_NAMESPACE(x)   } /* x */
#endif

#include <vector>
#include <stdio.h>

#include "basisinfo.h"

BEGIN_NAMESPACE(Dft)

/** A way to store sparse matrix patterns */
class SparsePattern {
 public:
  /** ranges are upper-exclusive: involve i: lo <= i < hi. */
  struct Interval {
    int lo, hi;
  Interval(int l_, int h_) : lo(l_), hi(h_){}
  };
  typedef std::vector<Interval> IntervalList;
  struct Column {
    IntervalList list;

    void addInterval(int lo, int hi);
    void addIntervals(int nIntervals, int (*intervals)[2]);
    struct Iterator {
      IntervalList::const_iterator current, end;
      int pos;
      Iterator(const IntervalList::const_iterator& beg,
               const IntervalList::const_iterator& end_, int p)
        : current(beg), end(end_), pos(p)
      {}

      Iterator& operator++() {
        ++pos;
#if 0
        if(pos == current->hi)
          printf("Iterator increased to %d current limit %d last? %s %s\n",
                 pos, current->hi,
                 & *current == & *end ? "YES" : "NO",
                 current == end ? "YES" : "NO");
#endif
        if(pos >= current->hi) {
          ++current;
          if(current != end)
            pos = current->lo; 
          else pos = 0;
        }
        return *this;
      }
      bool operator!=(const Iterator& other) const {
        bool res = !(& *current == & *other.current && pos == other.pos);
#if 0
        printf("Iterator::operator!=() compares %p with %p, returns %s \n",
               & *current, & *other.current, res ? "TRUE" : "FALSE");
#endif
        return res;
      }
      int operator*() const {
        //printf("Iterator::operator*() returns %d\n", pos);
        return pos;
      }
      const Interval* operator->() const {
        return &(*current);
      }
      
    };

    Iterator begin() const {
      IntervalList::const_iterator a = list.begin();
      IntervalList::const_iterator b = list.end();
      return Iterator(a, b, a != list.end() ? a->lo : 0);
    }

    Iterator end() const {
      return Iterator(list.end(),list.end(),0);
    }

    int size() const {
      int result = 0;
      for(IntervalList::const_iterator i = list.begin();
          i != list.end(); ++i)
        result += i->hi- i->lo;
      return result;
    }
  };

 private:
  const BasisInfoStruct& bis;
  Column *ranges;
 public:
 explicit SparsePattern(const BasisInfoStruct& bis_)
    : bis(bis_), ranges(new Column[bis_.noOfBasisFuncs])
    { }
    
    ~SparsePattern() {
      delete []ranges;
    }

    /** marks specified ranges as used.
    */
    void add(int nRanges, const int (*range)[2]);

    void save(FILE *f) const;
    void load(FILE *f);
    const Column& operator[](int column) const {
      return ranges[column];
    }

    /** returns the number of stored elements for specified column. */
    int getColumnSize(int col) const {
      return ranges[col].size();
    }

    /** Returns the dimension of the pattern. Auxiliary function. */
    int size() const {
      return bis.noOfBasisFuncs;
    }
    /** returns the total number of nonzero elements. */
    int sizeTotal() const;
};

void setupShellMap(const BasisInfoStruct& bis, int *shellMap, int *aoMap);

END_NAMESPACE(Dft)

#endif /* _DFT_SPARSE_PATTERN_H_ */