This file is indexed.

/usr/include/mmdb/mmdb_coormngr.h is in libmmdb-dev 1.25.5-2.

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
//  $Id: mmdb_coormngr.h,v 1.29 2012/01/26 17:52:20 ekr Exp $
//  =================================================================
//
//   CCP4 Coordinate Library: support of coordinate-related
//   functionality in protein crystallography applications.
//
//   Copyright (C) Eugene Krissinel 2000-2008.
//
//    This library is free software: you can redistribute it and/or 
//    modify it under the terms of the GNU Lesser General Public 
//    License version 3, modified in accordance with the provisions 
//    of the license to address the requirements of UK law.
//
//    You should have received a copy of the modified GNU Lesser 
//    General Public License along with this library. If not, copies 
//    may be downloaded from http://www.ccp4.ac.uk/ccp4license.php
//
//    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 Lesser General Public License for more details.
//
//  =================================================================
//
//    08.07.08   <--  Date of Last Modification.
//                   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//  -----------------------------------------------------------------
//
//  **** Module  :  mmdb_coormngr <interface>
//       ~~~~~~~~~
//       Project :  MacroMolecular Data Base (MMDB)
//       ~~~~~~~~~
//  **** Classes :  CBrick           ( space brick                  )
//       ~~~~~~~~~  CMMDBCoorManager ( MMDB atom coordinate manager )
//
//  (C) E. Krissinel 2000-2008
//
//  =================================================================
//

#ifndef __MMDB_CoorMngr__
#define __MMDB_CoorMngr__

#ifndef  __MMDB_File__
#include "mmdb_file.h"
#endif



// ===========================  CBrick  ==============================

//  bricking control
#define BRICK_ON_1       0x00000001
#define BRICK_ON_2       0x00000002
#define BRICK_READY      0x00000004


DefineClass(CBrick);
typedef  PPCBrick * PPPCBrick;

class CBrick  {

  public :
    int     nAtoms;  // number of atoms hit into brick
    PPCAtom   Atom;  // pointers to atoms
    ivector     id;  // atom ids (in present realization, these are
                     // indices of atoms from the bricked array)

    CBrick ();
    ~CBrick();

    void  Clear   ();
    void  AddAtom ( PCAtom A, int atomid );

  protected :
    int  nAllocAtoms;
    void InitBrick();

};


// ===========================  CMBrick  =============================

//  Bricking multiple structures

DefineClass(CMBrick);
typedef  PPCMBrick * PPPCMBrick;

class CMBrick  {

  public :
    ivector  nAtoms;  // number of atoms in the brick
    PPCAtom  * Atom;  // pointers to atoms
    imatrix      id;  // atom ids (in present realization, these are
                      // indices of atoms from the bricked array)

    CMBrick ( int nStructures );
    ~CMBrick();

    void  Clear   ();
    void  AddAtom ( PCAtom A, int structNo, int atomid );

  protected :
    ivector  nAllocAtoms;
    int      nStruct;
    void InitMBrick ( int nStructures );

};



//  ====================  CGenSym  ========================

DefineClass(CGenSym);
DefineStreamFunctions(CGenSym);

class CGenSym : public CSymOps  {

  friend class CMMDBCoorManager;

  public :

    CGenSym ();
    CGenSym ( RPCStream Object );
    ~CGenSym();

    void FreeMemory();

    int  AddSymOp    ( cpstr XYZOperation );
    //  the number of just added operation may be obtained as
    //  Nop = CGenSym::GetNofSymOps()-1 .

    int  AddRenChain ( int Nop, const ChainID ch1, const ChainID ch2 );

    void Copy  ( PCSymOps GenSym );

    void write ( RCFile f );
    void read  ( RCFile f );

  protected :

    PChainID * chID1;   // pairs of chains to rename from chID1[n][i]
    PChainID * chID2;   // to chID2[n][i] for each operation n<Nops
    ivector    nChains; // number of chains to rename for each oper-n

    void InitGenSym();

  private :
    int        nOpAlloc;  // number of allocated operations

};


// =========================  SContact  =============================

DefineStructure(SContact);

struct SContact  {
  int      id1,id2;
  long     group;
  realtype dist;
  void Copy ( RSContact c );
  void Swap ( RSContact c );
};


// ========================  CMContact  =============================

DefineClass(CMContact);

class CMContact : public CStream  {

  public :
    int       nStruct,contactID;
    ivector   nAtoms;
    PPCAtom * Atom;
    imatrix   id;

    CMContact ( int nStructures  );
    ~CMContact();

    void    AddContact ( PCAtom A, int structNo, int atomid );

  protected:
    ivector nAlloc;

};

extern void DeleteMContacts ( PPCMContact & mcontact, int nContacts );


// ======================  CMMDBCoorManager  =========================

DefineClass(CMMDBCoorManager);
DefineStreamFunctions(CMMDBCoorManager);

//  ----  Atom extraction return codes
#define CID_Ok          0
#define CID_NoModel     1
#define CID_NoChain     2
#define CID_NoResidue   3
#define CID_NoAtom      4
#define CID_WrongPath   5

//  ----  generate symmetry mates return codes
#define GSM_Ok                0
#define GSM_NoSymOps          1
#define GSM_NoTransfMatrices  2
#define GSM_NoCell            3

class CMMDBCoorManager : public CMMDBFile  {

  public :

    int CoorIDCode; // last return from atom extraction procedure

    CMMDBCoorManager ();
    CMMDBCoorManager ( RPCStream Object );
    ~CMMDBCoorManager();


    //  ----------------------------------------------------------

    int  SetDefaultCoorID ( cpstr CID );


    //  ----------------  Bricking  ------------------------------

    void  RemoveBricks ();
    Boolean areBricks  () { return (Brick!=NULL); }
    void  MakeBricks   ( PPCAtom atmvec, int avlen, 
                         realtype Margin, realtype BrickSize=6.0 );
    void  GetBrickDimension ( 
                         int & nxmax, int & nymax, int & nzmax );
    void  GetBrickCoor ( PCAtom A, int & nx, int & ny, int & nz );
    void  GetBrickCoor ( realtype x, realtype y, realtype z,
                         int & nx, int & ny, int & nz );
    PCBrick GetBrick   ( int   nx, int   ny, int   nz );

    void  RemoveMBricks ();
    Boolean areMBricks  () { return (MBrick!=NULL); }
    void  MakeMBricks   ( PPCAtom * atmvec, ivector avlen,
                          int nStructures, realtype Margin,
                          realtype BrickSize=6.0 );
    void  GetMBrickDimension ( 
                         int & nxmax, int & nymax, int & nzmax );
    void  GetMBrickCoor ( PCAtom A, int & nx, int & ny, int & nz );
    void  GetMBrickCoor ( realtype x, realtype y, realtype z,
                          int & nx, int & ny, int & nz );
    PCMBrick GetMBrick  ( int   nx, int   ny, int   nz );

    //  ----------------  Extracting models  ---------------------

    int GetNumberOfModels ()  { return nModels; }
    int  GetFirstModelNum ();
    PCModel GetFirstDefinedModel();
    PCModel      GetModel ( int   modelNo  );  // 1<=modelNo<=nModels
    PCModel      GetModel ( cpstr CID );
    void    GetModelTable ( PPCModel & modTable,
                            int & NumberOfModels );

    //  ----------------  Deleting models  -----------------------

    int  DeleteModel ( cpstr CID );
    int  DeleteModel ( int modelNo );  // 1<=modelNo<=nOfModels

    //  ----------------  Adding/Inserting models  ---------------

    int  AddModel     ( PCModel model );
    int  InsModel     ( PCModel model, int modelNo );
    void RotateModels ( int  modelNo1, int modelNo2, int rotdir );
    void SwapModels   ( int  modelNo1, int modelNo2 );

    //  ----------------  Extracting chains  ---------------------

    int GetNumberOfChains ( int   modelNo  );
    int GetNumberOfChains ( cpstr CID );
    PCChain      GetChain ( int modelNo, const ChainID chainID );
    PCChain      GetChain ( int modelNo, int   chainNo );
    PCChain      GetChain ( cpstr CID );
    void    GetChainTable ( int modelNo, PPCChain & chainTable,
                            int & NumberOfChains );
    void    GetChainTable ( cpstr CID, PPCChain & chainTable,
                            int & NumberOfChains );

    //  -----------------  Deleting chains  ----------------------

    int  DeleteChain     ( int modelNo, const ChainID chID );
    int  DeleteChain     ( int modelNo, int chainNo  );
    int  DeleteAllChains ( int modelNo );
    int  DeleteAllChains ();

    //  ------------------  Adding chains  -----------------------

    int  AddChain ( int modelNo, PCChain chain );

    //  ----------------  Extracting residues  -------------------

    int GetNumberOfResidues ( int modelNo, const ChainID chainID );
    int GetNumberOfResidues ( int modelNo, int   chainNo );
    int GetNumberOfResidues ( cpstr CID );
    PCResidue    GetResidue ( int modelNo, const ChainID chainID,
                              int seqNo,   const InsCode insCode );
    PCResidue    GetResidue ( int modelNo, int   chainNo,
                              int seqNo,   const InsCode insCode );
    PCResidue    GetResidue ( int modelNo, const ChainID chainID,
                                                     int resNo );
    PCResidue    GetResidue ( int modelNo, int   chainNo, int resNo );
    PCResidue    GetResidue ( cpstr CID );
    int        GetResidueNo ( int modelNo, const ChainID chainID,
                              int seqNo,   const InsCode insCode );
    int        GetResidueNo ( int modelNo, int   chainNo,
                              int seqNo,   const InsCode insCode );
    void    GetResidueTable ( PPCResidue & resTable,
                              int & NumberOfResidues );
    void    GetResidueTable ( int modelNo, const ChainID chainID,
                              PPCResidue & resTable,
                              int & NumberOfResidues );
    void    GetResidueTable ( int modelNo, int chainNo,
                              PPCResidue & resTable,
                              int & NumberOfResidues );
    void    GetResidueTable ( cpstr CID, PPCResidue & resTable,
                              int & NumberOfResidues );


    //  -----------------  Deleting residues  -----------------------

    int DeleteResidue     ( int modelNo, const ChainID chainID,
                            int seqNo,   const InsCode insCode );
    int DeleteResidue     ( int modelNo, const ChainID chainID,
                                                   int resNo );
    int DeleteResidue     ( int modelNo, int   chainNo,
                            int seqNo,   const InsCode insCode );
    int DeleteResidue     ( int modelNo, int   chainNo, int resNo );
    int DeleteAllResidues ( int modelNo, const ChainID chainID );
    int DeleteAllResidues ( int modelNo, int   chainNo );
    int DeleteAllResidues ( int modelNo );
    int DeleteAllResidues ();
    int DeleteSolvent     ();

    //  -------------------  Adding residues  -----------------------

    int AddResidue ( int modelNo, const ChainID chainID,
                                                 PCResidue res );
    int AddResidue ( int modelNo, int   chainNo, PCResidue res );

    // --------------------  Extracting atoms  ----------------------

    int   GetNumberOfAtoms ()  { return nAtoms;  }
    int   GetNumberOfAtoms ( int modelNo, const ChainID chainID,
                             int seqNo,   const InsCode insCode );
    int   GetNumberOfAtoms ( int modelNo, int   chainNo,
                             int seqNo,   const InsCode insCode );
    int   GetNumberOfAtoms ( int modelNo, const ChainID chainID,
                                                    int resNo );
    int   GetNumberOfAtoms ( int modelNo, int   chainNo, int resNo );
    int   GetNumberOfAtoms ( cpstr CID );

    PCAtom GetAtom (
              int            modelNo, // model serial number 1...
              const ChainID  chID,    // chain ID
              int            seqNo,   // residue sequence number
              const InsCode  insCode, // residue insertion code
              const AtomName aname,   // atom name
              const Element  elmnt,   // chemical element code or '*'
              const AltLoc   aloc     // alternate location indicator
                   );

    PCAtom GetAtom (
              int            modelNo, // model serial number 1...
              const ChainID  chID,    // chain ID
              int            seqNo,   // residue sequence number
              const InsCode  insCode, // residue insertion code
              int            atomNo   // atom number 0..
                   );

    PCAtom GetAtom (
              int            modelNo, // model serial number 1...
              const ChainID  chID,    // chain ID
              int            resNo,   // residue number 0..
              const AtomName aname,   // atom name
              const Element  elmnt,   // chemical element code or '*'
              const AltLoc   aloc     // alternate location indicator
                   );

    PCAtom GetAtom (
              int            modelNo, // model serial number 1...
              const ChainID  chID,    // chain ID
              int            resNo,   // residue number 0..
              int            atomNo   // atom number 0..
                   );

    PCAtom GetAtom (
              int            modelNo, // model serial number 1...
              int            chNo,    // chain number 0..
              int            seqNo,   // residue sequence number
              const InsCode  insCode, // residue insertion code
              const AtomName aname,   // atom name
              const Element  elmnt,   // chemical element code or '*'
              const AltLoc   aloc     // alternate location indicator
                   );

    PCAtom GetAtom (
              int            modelNo, // model serial number 1...
              int            chNo,    // chain number 0...
              int            seqNo,   // residue sequence number
              const InsCode  insCode, // residue insertion code
              int            atomNo   // atom number 0...
                   );

    PCAtom GetAtom (
              int            modelNo, // model serial number 1...
              int            chNo,    // chain number 0...
              int            resNo,   // residue number 0...
              const AtomName aname,   // atom name
              const Element  elmnt,   // chemical element code or '*'
              const AltLoc   aloc     // alternate location indicator
                   );

    PCAtom GetAtom (
              int      modelNo, // model serial number 1...
              int      chNo,    // chain number 0...
              int      resNo,   // residue number 0...
              int      atomNo   // atom number 0...
                   );


    //   GetAtom(CID) returns atom answering to the following
    // CID pattern:
    //   /mdl/chn/seq(res).i/atm[elm]:a
    // where
    //   mdl   - model number (mandatory); at least model #1 is always
    //           present
    //   chn   - chain identifier ( mandatory)
    //   seq   - residue sequence number (mandatory)
    //   (res) - residue name in round brackets (may be omitted)
    //   .i    - insert code after a dot; if '.i' or 'i' is missing
    //           then residue without an insertion code is looked
    //           for
    //   atm   - atom name (mandatory)
    //   [elm] - chemical element code in square brackets; it may
    //           be omitted but could be helpful for e.g.
    //           distinguishing C_alpha and CA
    //   :a    - alternate location indicator after colon; if
    //           ':a' or 'a' is missing then an atom without
    //           alternate location indicator is looked for.
    // All spaces are ignored, all identifiers should be in capital
    // letters (comparisons are case-sensitive).
    PCAtom GetAtom ( cpstr CID );


    void GetAtomTable ( PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable ( int modelNo, const ChainID chainID,
                        int seqNo,   const InsCode insCode,
                        PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable ( int modelNo, int   chainNo,
                        int seqNo,   const InsCode insCode,
                        PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable ( int modelNo, const ChainID chainID, int resNo,
                        PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable ( int modelNo, int     chainNo, int resNo,
                        PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable ( cpstr CID, PPCAtom & atomTable,
                        int & NumberOfAtoms );


    //   GetAtomTable1(..) returns atom table without TER atoms and
    // without NULL atom pointers. NumberOfAtoms returns the actual
    // number of atom pointers in atomTable.
    //   atomTable is allocated within the function. If it was
    // not set to NULL before calling the function, the function will
    // attempt to deallocate it first.
    //   The application is responsible for deleting atomTable,
    // however it must not touch atom pointers, i.e. use simply
    // "delete atomTable;". Never pass atomTable from GetAtomTable(..)
    // into this function, unless you set it to NULL before doing that.
    void GetAtomTable1 ( PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable1 ( int modelNo, const ChainID chainID,
                         int seqNo,   const InsCode insCode,
                         PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable1 ( int modelNo, int   chainNo,
                         int seqNo,   const InsCode insCode,
                         PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable1 ( int modelNo, const ChainID chainID, int resNo,
                         PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable1 ( int modelNo, int     chainNo, int resNo,
                         PPCAtom & atomTable, int & NumberOfAtoms );
    void GetAtomTable1 ( cpstr CID, PPCAtom & atomTable,
                         int & NumberOfAtoms );


    //  --------------------  Deleting atoms  -----------------------

    int DeleteAtom ( int            modelNo,
                     const ChainID  chID,
                     int            seqNo,
                     const InsCode  insCode,
                     const AtomName aname,
                     const Element  elmnt,
                     const AltLoc   aloc );
    int DeleteAtom ( int           modelNo,
                     const ChainID chID,
                     int           seqNo,
                     const InsCode insCode,
                     int           atomNo );
    int DeleteAtom ( int            modelNo,
                     const ChainID  chID,
                     int            resNo,
                     const AtomName aname,
                     const Element  elmnt,
                     const AltLoc   aloc );
    int DeleteAtom ( int modelNo, const ChainID chID,
                     int resNo, int atomNo );
    int DeleteAtom ( int modelNo, int chNo, int seqNo,
                     const InsCode  insCode,
                     const AtomName aname,
                     const Element  elmnt,
                     const AltLoc   aloc );
    int DeleteAtom ( int modelNo, int chNo, int seqNo,
                     const InsCode insCode, int atomNo );
    int DeleteAtom ( int modelNo, int chNo, int resNo,
                     const AtomName aname,
                     const Element  elmnt,
                     const AltLoc   aloc );
    int DeleteAtom ( int modelNo, int chNo, int resNo, int atomNo );

    int DeleteAllAtoms ( int modelNo, const ChainID chID,
                         int seqNo,   const InsCode insCode );
    int DeleteAllAtoms ( int modelNo, const ChainID chID, int resNo );
    int DeleteAllAtoms ( int modelNo, const ChainID chID );
    int DeleteAllAtoms ( int modelNo, int chNo, int seqNo,
                         const InsCode insCode );
    int DeleteAllAtoms ( int modelNo, int chNo, int resNo );
    int DeleteAllAtoms ( int modelNo, int chNo );
    int DeleteAllAtoms ( int modelNo );
    int DeleteAllAtoms ();

    //  This function leaves only alternative location with maximal
    // occupancy, if those are equal or unspecified, the one with
    // "least" alternative location indicator.
    //  The function returns the number of deleted atoms and optimizes
    // the atom index.
    int DeleteAltLocs  ();


    //  ---------------------  Adding atoms  ------------------------

    int AddAtom ( int modelNo, const ChainID chID,
                  int seqNo,   const InsCode insCode, PCAtom atom );
    int AddAtom ( int modelNo, const ChainID chID, int resNo,
                                                      PCAtom atom );
    int AddAtom ( int modelNo, int chNo, int seqNo,
                               const InsCode insCode, PCAtom atom );
    int AddAtom ( int modelNo, int chNo, int resNo, PCAtom  atom );


    // --------------------  Transformations  -----------------------

    int  GenerateSymMates ( PCGenSym GenSym=NULL );
                             // 1: no Sym operations,
                             // 2: no fract/orth matrices
                             // 3: no cell parameters
                             // 0: Ok

    void ApplyTransform   ( mat44 & TMatrix ); // simply transforms all
                                          // coordinates by multiplying
                                          // with matrix TMatrix

    int  BringToUnitCell();  // brings all chains into 0th unit cell

    //   Frac2Orth(..) and Orth2Frac(..) transform between fractional
    // and orthogonal coordinates, if areMatrices() returns True.
    // If the transformation matrices were not set, the functions just
    // copy the coordinates.  Returns True if the transformation was
    // done; False return means that transformation matrices were not
    // calculated
    Boolean Frac2Orth (
              realtype   xfrac, realtype   yfrac, realtype   zfrac,
              realtype & xorth, realtype & yorth, realtype & zorth );
    Boolean Orth2Frac (
              realtype   xorth, realtype   yorth, realtype   zorth,
              realtype & xfrac, realtype & yfrac, realtype & zfrac );


    //   Below, F and T are transformation matrices in fractional and
    // orthogonal coordinates, respectively.
    Boolean Frac2Orth ( mat44 & F, mat44 & T );
    Boolean Orth2Frac ( mat44 & T, mat44 & F );

    // ====================  Seeking contacts  ======================

    void  SeekContacts (
             PPCAtom    AIndex,    // index of atoms [0..ilen-1]
             int        ilen,      // length of index
             int        atomNum,   // number of 1st contact atom
                                   // in the index. All other atoms
                                   // are checked for contact with
                                   // 1st atom
             realtype   dist1,     // minimal contact distance
             realtype   dist2,     // maximal contact distance
             int        seqDist,   // the sequence distance to neglect.
                                   // If seqDist==0, all atoms are
                                   // checked for contact. If
                                   // seqDist==1, the atoms belonging
                                   // to the same residue as atom
                                   // AIndex[atomNum], are neglected.
                                   // If seqDist>1, all atoms belonging
                                   // to residues closer than
                                   // +/-(seqDist-1) around that of 
                                   // atom AIndex[atomNum], are
                                   // neglected. If chain is broken
                                   // (has a gap) on section
                                   // [-(seqDist-1)..seqDist-1], the
                                   // section of neglection is
                                   // shortened to that gap.
             RPSContact contact,   // indices of contacting atoms
                                   // [0..ncontacts-1]. contact[i].id1
                                   // is set to atomNum and
                                   // contact[i].id2 is set to the
                                   // index of 2nd contacting atom
                                   // in vector AIndex
             int &      ncontacts, // number of contacts found. If
                                   // ncontacts>0 on input, it is
                                   // assumed that new contacts that
                                   // newly found contacts should be
                                   // appended to those already
                                   // existing
             int        maxlen=0,  // if <=0, then vector contact is
                                   // allocated dynamically. If
                                   // contact!=NULL, then it is
                                   // appended with new contacts.
                                   // The application is responsible
                                   // for deallocation of contact
                                   // after use.
                                   //   If maxlen>0 then vector contact
                                   // is prohibited of dynamical
                                   // allocation/deallocation. In this
                                   // case, not more than maxlen
                                   // contacts will be returned.
             long       group=0    // a contact group ID, which will be
                                   // simply stored in contact[i].group
                                   // fields. This ID may be useful
                                   // if contacts are obtained in
                                   // multiple calls of the function
                       );

    void  SeekContacts (
             PCAtom     A,         // 1st atom in contact
             PPCAtom    AIndex,    // index of atoms [0..ilen-1] to
                                   // check for contact with 1st atom
             int        ilen,      // length of index
             realtype   dist1,     // minimal contact distance
             realtype   dist2,     // maximal contact distance
             int        seqDist,   // the sequence distance to neglect.
                                   // If seqDist==0, all atoms are
                                   // checked for contact. If
                                   // seqDist==1, the atoms belonging
                                   // to the same residue as atom
                                   // A, are neglected. If seqDist>1,
                                   // all atoms belonging to residues
                                   // closer than +/-(seqDist-1) around
                                   // that of atom A, are neglected. If
                                   // chain is broken (has a gap) on
                                   // section
                                   // [-(seqDist-1)..seqDist-1], the
                                   // section of neglection is
                                   // shortened to that gap.
             RPSContact contact,   // indices of contacting atoms
                                   // [0..ncontacts-1]. contact[i].id1
                                   // is set to -1, and contact[i].id2
                                   // is set to the index of 2nd
                                   // contacting atom in vector AIndex
             int &      ncontacts, // number of contacts found. If
                                   // ncontacts>0 on input, it is
                                   // assumed that new contacts that
                                   // newly found contacts should be
                                   // appended those already existing
             int        maxlen=0,  // if <=0, then vector contact is
                                   // allocated dynamically. If
                                   // contact!=NULL, then it is
                                   // appended with new contacts.
                                   // The application is responsible
                                   // for deallocation of contact
                                   // after use.
                                   //   If maxlen>0 then vector contact
                                   // is prohibited of dynamical
                                   // allocation/deallocation. In this
                                   // case, not more than maxlen
                                   // contacts will be returned.
             long       group=0    // a contact group ID, which will be
                                   // simply stored in contact[i].group
                                   // fields. This ID may be useful
                                   // if contacts are obtained in
                                   // multiple calls of the function
                       );

    void  SeekContacts (
             PPCAtom    AIndex1,   //  1st atom index [0..ilen1-1]
             int        ilen1,     //  length of 1st index
             PPCAtom    AIndex2,   //  2nd atom index [0..ilen2-1] to
                                   // check for contact with 1st index
             int        ilen2,     //  length of 2nd index
             realtype   dist1,     //  minimal contact distance
             realtype   dist2,     //  maximal contact distance
             int        seqDist,   //  the sequence distance to
                                   // neglect.
                                   //  If seqDist==0, all atoms are
                                   // checked for contact.
                                   //  If seqDist==1, the atoms
                                   // belonging to the same residue
                                   // are neglected.
                                   //  If seqDist>1, all atoms
                                   // belonging to residues closer than
                                   // +/-(seqDist-1) to each other,
                                   // are neglected. If chain is broken
                                   // (has a gap) on section
                                   // [-(seqDist-1)..seqDist-1], the
                                   // section of neglection is
                                   // shortened to that gap.
             RPSContact contact,   //  indices of contacting atoms
                                   // [0..ncontacts-1]. contact[i].id1
                                   // contains number of atom from 1st
                                   // index, and contact[i].id2
                                   // contains number of atom from 2nd
                                   // index, contacting with the former
                                   // one
             int &      ncontacts, //  number of contacts found. If
                                   // ncontacts>0 on input, it is
                                   // assumed that newly found
                                   // contacts should be appended to
                                   // those already existing
             int        maxlen=0,  //  if <=0, then vector contact is
                                   // allocated dynamically. If
                                   // contact!=NULL, then it is
                                   // appended with new contacts.
                                   // The application is responsible
                                   // for deallocation of contact
                                   // after use.
                                   //   If maxlen>0 then vector contact
                                   // is prohibited of dynamical
                                   // allocation/deallocation. In this
                                   // case, not more than maxlen
                                   // contacts will be returned.
             mat44 * TMatrix=NULL, //  transformation matrix for 2nd
                                   // set of atoms (AIndex2)
             long       group=0,   //  a contact group ID, which will
                                   // be stored in contact[i].group
                                   // fields. This ID may be useful
                                   // if contacts are obtained in
                                   // multiple calls of the function
             int     bricking=0,   //  bricking control; may be a
                                   // combination of BRICK_ON_1 or
                                   // BRICK_ON_2 with BRICK_READY
             Boolean doSqrt=True   // if False, then SContact contains
                                   // square distances
                       );

    //  Simplified optimized for speed version:
    //    - no NULL pointers and Ters in AIndex1 and AIndex2
    //    - no checks for identity atoms in AIndex1 and AIndex2
    //    - contact must be pre-allocated with at least ilen1*ilen2
    //      elements
    //    - contact returns square distances
    //    - ncontacts is always reset
    void  SeekContacts (
             PPCAtom    AIndex1,   //  1st atom index [0..ilen1-1]
             int        ilen1,     //  length of 1st index
             PPCAtom    AIndex2,   //  2nd atom index [0..ilen2-1] to
                                   // check for contact with 1st index
             int        ilen2,     //  length of 2nd index
             realtype   contDist,  //  maximal contact distance
             PSContact  contact,   //  indices of contacting atoms
                                   // [0..ncontacts-1]. contact[i].id1
                                   // contains number of atom from 1st
                                   // index, and contact[i].id2
                                   // contains number of atom from 2nd
                                   // index, contacting with the former
                                   // one. Must be pre-allocated
             int &      ncontacts, //  number of contacts found
             int       bricking=0  //  bricking control; may be a
                                   // combination of BRICK_ON_1 or
                                   // BRICK_ON_2 with BRICK_READY
                       );

    void  SeekContacts (
           PPCAtom       AIndex1,  //  1st atom index [0..ilen1-1]
           int           ilen1,    //  length of 1st index
           PPCAtom *     AIndex2,  //  indexes of atoms to be checked
                                   // for contact with each atom from
                                   // Aindex1; dimension
                                   // [0..nStructures-1][0..ilen2[i]-1]
           ivector       ilen2,    //  lengths of indexes AIndex2
           int           nStructures, //  number of indexes AIndex2
           realtype      dist1,    //  minimal contact distance
           realtype      dist2,    //  maximal contact distance
           PPCMContact & contact,  // resulting contacts, one structure
                                   // per each position in AIndex1. If
                                   // AIndex1[i] is NULL, contact[i] is
                                   // also NULL. "contact" is always
                                   // allocated, no re-use or
                                   // re-allocation is attempted.
           int            bricking=0  //  bricking control; may be
                                   // BRICK_READY if AIndex2 does not
                                  // change
                       );

  protected :

    //  bricks
    realtype     brick_size, xbrick_0,ybrick_0,zbrick_0;
    int          nbrick_x,nbrick_y,nbrick_z;
    PPPCBrick  * Brick;

    realtype     mbrick_size, xmbrick_0,ymbrick_0,zmbrick_0;
    int          nmbrick_x,nmbrick_y,nmbrick_z;
    PPPCMBrick * MBrick;

    //  ---------------  Stream I/O  -----------------------------
    void  write ( RCFile f );
    void  read  ( RCFile f );

    void  InitMMDBCoorManager();

    void  ApplySymTransform ( int SymMatrixNo, PCGenSym GenSym=NULL );

    void  ResetManager ();

    void  FindSeqSection    ( PCAtom  atom, int  seqDist,
                              int  &  seq1, int  &  seq2 );
    Boolean    isContact    ( PCAtom    a1, PCAtom    a2,
                              int     seq1, int     seq2,
                              realtype  dd, realtype d12,
                              realtype d22, realtype & d2 );
    Boolean    isContact    ( realtype   x, realtype   y,
                              realtype   z, PCAtom    a2,
                              realtype  dd, realtype d12,
                              realtype d22, realtype & d2 );

};



//  ===================================================================



//   GetEulerRotMatrix(..) calculates the Euler rotation matrix
// for rotation:
//                   1) about z-axis by angle alpha
//                   2) about new y-axis by angle beta
//                   3) about new z-axis by angle gamma
extern void  GetEulerRotMatrix ( mat33 & erm,   realtype alpha, 
                                 realtype beta, realtype gamma );

//  GetEulerTMatrix(..) calculates the Euler rotation-translation
// matrix for rotation:
//                   1) about z-axis by angle alpha
//                   2) about new y-axis by angle beta
//                   3) about new z-axis by angle gamma
//  Point (x0,y0,z0) is the center of rotation.
extern void  GetEulerTMatrix ( mat44 & erm,   realtype alpha, 
                          realtype beta, realtype gamma,
                          realtype x0,   realtype y0,  realtype z0 );

//  Euler rotation:  1) about z-axis by angle alpha
//                   2) about new y-axis by angle beta
//                   3) about new z-axis by angle gamma
//  Point (x0,y0,z0) is the center of rotation.
extern void EulerRotation ( PPCAtom A, int nA,
                         realtype alpha, realtype beta, realtype gamma,
                         realtype x0,    realtype y0,   realtype z0 );

//   GetVecRotMatrix(..) calculates the rotation matrix for
// rotation by angle alpha about arbitrary vector directed
// as (vx,vy,vz) = (vx2-vx1,vy2-vy1,vz2-vz1).
extern void GetVecRotMatrix ( mat33 & vrm,  realtype alpha, 
                           realtype vx,  realtype vy, realtype vz );


//    Given the rotation matrix vrm, GetRotParameters(..)
//  returns the rotation angle alpha and the normalized
//  rotation axis vector (vx,vy,vz).
//    The rotation angle and vector are determined up to
//  their sign (however correlated, so that being substituted
//  into GetVecRotMatrix(..) they yield the same rotation
//  matrix).
//    The function does not check for vrm to be a valid
//  rotation matrix.
extern void GetRotParameters ( mat33 & vrm, realtype & alpha, 
                       realtype & vx, realtype & vy, realtype & vz );


//   GetVecTMatrix(..) calculates the rotation-translation matrix
// for rotation by angle alpha about arbitrary vector directed as
// (vx,vy,vz) = (vx2-vx1,vy2-vy1,vz2-vz1). Point (x0,y0,z0) is
// the center of rotation -- actually a point belonging to the
// rotation axis.
extern void GetVecTMatrix  ( mat44 & vrm, realtype alpha, 
                             realtype vx, realtype vy, realtype vz,
                             realtype x0, realtype y0, realtype z0 );

//   Vector rotation is rotation by angle alpha about arbitrary
// vector directed as (vx,vy,vz) = (vx2-vx1,vy2-vy1,vz2-vz1).
// Point (x0,y0,z0) is the center of rotation -- actually
// a point belonging to the rotation axis.
extern void VectorRotation ( PPCAtom A, int nA,  realtype alpha,
                             realtype vx, realtype vy, realtype vz,
                             realtype x0, realtype y0, realtype z0 );

extern void GetMassCenter  ( PPCAtom A, int nA,
                      realtype & xmc, realtype & ymc, realtype & zmc );


#define SPOSEAT_Ok       0
#define SPOSEAT_NoAtoms  1
#define SPOSEAT_SVD_Fail 2

//   Given two sets of atoms, A1 and A2, SuperposeAtoms(...) calculates
// the rotational-translational matrix T such that |T*A1 - A2| is
// minimal in least-square terms.
//   If vector C is not given (default), all nA atoms of set A1 are
// considered as corresponding to nA first atoms of set A2,
// A1[i] <-> A2[i], 0<=i<nA .
//   If vector C is given, then the correspondence of atoms is
// established as A1[i] <-> A2[C[i]] only for those i that C[i]>=0.
// The default option (C==NULL) is thus identical to C[i]==i, 0<=i<nA.
//   Upon normal completion, the procedure returns SPOSEAT_Ok.

extern int SuperposeAtoms ( mat44 & T, PPCAtom A1, int nA, PPCAtom A2,
                            ivector C=NULL );


#define CNSORT_OFF    0
#define CNSORT_1INC   1
#define CNSORT_1DEC   2
#define CNSORT_2INC   3
#define CNSORT_2DEC   4
#define CNSORT_DINC   5
#define CNSORT_DDEC   6

extern void  SortContacts ( PSContact contact, int ncontacts,
                            int sortmode );


#define  NO_TORSION  (-MaxReal)

extern realtype getPhi ( PPCAtom A );  // A[0] - A[3] used
extern realtype getPsi ( PPCAtom A );  // A[0] - A[2] used

#endif