Class CgMonomerStore

Hierarchy

Store
- CgMonomerStore
  - CgAminoAcidStore
  - CgNucleotideStore

Indexable

[k: string]: any

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new CgMonomerStore(size?: number): CgMonomerStore

Inherited from Store.constructor
- Defined in backend/src/store/store.ts:26
Parameters
- Default value size: number = 0
Returns CgMonomerStore

Properties

_fields

_fields: StoreField[]

count

count: number

globalId

globalId: Int32Array

length

length: number

pdbId

pdbId: Int32Array

Identification/index of relevant all-atom residue; -1 if no reference exists

Accessors

_defaultFields

get _defaultFields(): StoreField[]

Overrides Store._defaultFields
- Defined in backend/src/catana/data_model/store/cg-monomer-store.ts:11
Returns StoreField[]

estimatedSizeInBytes

get estimatedSizeInBytes(): number

Inherited from Store.estimatedSizeInBytes
- Defined in backend/src/store/store.ts:340
Returns number

Methods

_init

_init(size: number): void

Inherited from Store._init
- Defined in backend/src/store/store.ts:41
Initialize the store

Parameters
- size: number
  
  size to initialize
Returns void

_initField

_initField(name: string, size: number, type: TypedArrayString): void

Inherited from Store._initField
- Defined in backend/src/store/store.ts:59
Initialize a field

Parameters
- name: string
  
  field name
- size: number
  
  element size
- type: TypedArrayString
  
  data type, one of int8, int16, int32, uint8, uint16, uint32, float32
Returns void

addField

addField(name: string, size: number, type: TypedArrayString): void

Inherited from Store.addField
- Defined in backend/src/store/store.ts:71
Add a field

Parameters
- name: string
  
  field name
- size: number
  
  element size
- type: TypedArrayString
  
  data type, one of int8, int16, int32, uint8, uint16, uint32, float32
Returns void

appendRecords

appendRecords(addedCount: number, newValRec?: undefined | {}): void

Inherited from Store.appendRecords
- Defined in backend/src/store/store.ts:116
Parameters
- addedCount: number
- Optional newValRec: undefined | {}
Returns void

clear

clear(): void

Inherited from Store.clear
- Defined in backend/src/store/store.ts:321
Empty the store

Returns void

copyFrom

copyFrom(other: Store, thisOffset: number, otherOffset: number, length: number): void

Inherited from Store.copyFrom
- Defined in backend/src/store/store.ts:186
Copy data from one store to another

Parameters
- other: Store
  
  store to copy from
- thisOffset: number
  
  offset to start copying to
- otherOffset: number
  
  offset to start copying from
- length: number
  
  number of entries to copy
Returns void

copyWithin

copyWithin(destinationOffset: number, sourceOffset: number, length: number): void

Inherited from Store.copyWithin
- Defined in backend/src/store/store.ts:210
Copy data within this store

Parameters
- destinationOffset: number
  
  offset to start copying to
- sourceOffset: number
  
  offset to start copying from
- length: number
  
  number of entries to copy
Returns void

dispose

dispose(): void

Inherited from Store.dispose
- Defined in backend/src/store/store.ts:329
Dispose of the store entries and fields

Returns void

growIfFull

growIfFull(): void

Inherited from Store.growIfFull
- Defined in backend/src/store/store.ts:163
Resize the store to 1.5 times its current size if full

Returns void

insertRecords

insertRecords(index: number, addedCount: number, newValRec?: undefined | {}): void

Inherited from Store.insertRecords
- Defined in backend/src/store/store.ts:88
Allows to add values to the store fields simultaneously. It is expected that all of the fields provided by the store will have their value defined in the newly added record and all the arrays with values are of the same length.

Parameters
- index: number
  
  index where the data should be inserted
- addedCount: number
- Optional newValRec: undefined | {}
  
  defines the values to add; if not provided, the store will be resized but no values will be overriden
  
  Catana extension.
Returns void

prependRecords

prependRecords(addedCount: number, newValRec?: undefined | {}): void

Inherited from Store.prependRecords
- Defined in backend/src/store/store.ts:120
Parameters
- addedCount: number
- Optional newValRec: undefined | {}
Returns void

removeRecord

removeRecord(index: number): void

Inherited from Store.removeRecord
- Defined in backend/src/store/store.ts:124
Parameters
- index: number
Returns void

resize

resize(size?: undefined | number): void

Inherited from Store.resize
- Defined in backend/src/store/store.ts:136
Resize the store to the new size

Parameters
- Optional size: undefined | number
  
  new size
Returns void

rotate

rotate(shift: number): void

Inherited from Store.rotate
- Defined in backend/src/store/store.ts:299
Left-rotates the array with the given shift in the desired direction In-situ algorithm

Catana extension

Parameters
- shift: number
Returns void

shrinkToFit

shrinkToFit(): void

Inherited from Store.shrinkToFit
- Defined in backend/src/store/store.ts:174
Reduces the container length to equal its count. Catana extension.

Returns void

sort

sort(compareFunction: (a: any, b: any) => number): void

Inherited from Store.sort
- Defined in backend/src/store/store.ts:247
Sort entries in the store given the compare function

Parameters
- compareFunction: (a: any, b: any) => number
  
  function to sort by
  - - (a: any, b: any): number
    - Parameters
      - a: any
      - b: any
      Returns number
Returns void

Protected vectorDataFromArray

vectorDataFromArray(dataArr: Float32Array, i: number, sourceArr: number[]): void

- Defined in backend/src/catana/data_model/store/cg-monomer-store.ts:26
Stores [X, Y, Z] values stored in the source array to the corresponding index in the store's destination array

Parameters
- dataArr: Float32Array
  
  destionation array
- i: number
  
  index where the data should be stored
- sourceArr: number[]
  
  source array
Returns void

Protected vectorDataFromVector3

vectorDataFromVector3(dataArr: Float32Array, i: number, source: Vector3): void

- Defined in backend/src/catana/data_model/store/cg-monomer-store.ts:41
Stores [X, Y, Z] values stored in the source vector to the corresponding index in the store's destination array

Parameters
- dataArr: Float32Array
  
  destionation array
- i: number
  
  index where the data should be stored
- source: Vector3
  
  source vector
Returns void

Protected vectorDataToArray

vectorDataToArray(dataArr: Float32Array, i: number, destArr?: number[]): number[]

- Defined in backend/src/catana/data_model/store/cg-monomer-store.ts:57
Copies [X, Y, Z] values stored at the given index in the source store's array to the destination array (if provided)

Parameters
- dataArr: Float32Array
  
  source array
- i: number
  
  index from which the data should be copied
- Optional destArr: number[]
  
  destination array (if not provided, new array of size 3 will be initialized)
Returns number[]

reference to destArray if provided, otherwise reference to newly created array

Protected vectorDataToVector3

vectorDataToVector3(dataArr: Float32Array, i: number, vector?: Vector3): Vector3

- Defined in backend/src/catana/data_model/store/cg-monomer-store.ts:78
Copies [X, Y, Z] values stored at the given index in the source store's array to the destination vector (if provided)

Parameters
- dataArr: Float32Array
  
  source array
- i: number
  
  index from which the data should be copied
- Optional vector: Vector3
  
  destionation vector (if not provided, new vector will be instantiated)
Returns Vector3

reference to vector param if provided, otherwise reference to a newly created vector instance

Generated using TypeDoc