NGL@1.0.0-beta.7 Home Manual Reference Source Gallery

import Store from 'ngl/src/store/store.js'

public interface | source

Store

Direct Subclass:

AtomStore, BondStore, ChainStore, ModelStore, ResidueStore

Store base class

Constructor Summary

Public Constructor
public	constructor(size: Integer)

Member Summary

Public Members
public	[name]
public	count
public	length

Private Members
private	_fields

Method Summary

Public Methods
public	addField(name: String, size: Integer, type: String): undefined Add a field
public	clear(): undefined Empty the store
public	copyFrom(other: Store, thisOffset: Integer, otherOffset: Integer, length: Integer): undefined Copy data from one store to another
public	copyWithin(thisOffset: Integer, otherOffset: Integer, length: Integer): undefined Copy data within this store
public	dispose(): undefined Dispose of the store entries and fields
public	growIfFull(): undefined Resize the store to 1.5 times its current size if full
public	resize(size: Integer): undefined Resize the store to the new size
public	sort(compareFunction: [type]): undefined Sort entries in the store given the compare function

Private Methods
private	_init(size: Integer): undefined Initialize the store
private	_initField(name: String, size: Integer, type: String): undefined Initialize a field

Public Constructors

public constructor(size: Integer) source

Params:

Name	Type	Attribute	Description
size	Integer	optional	initial size

Public Members

public [name] source

public count source

public length source

Private Members

private _fields source

Public Methods

public addField(name: String, size: Integer, type: String): undefined source

Add a field

Params:

Name	Type	Attribute	Description
name	String		field name
size	Integer		element size
type	String		data type, one of int8, int16, int32, uint8, uint16, uint32, float32

Return:

public clear(): undefined source

Empty the store

Return:

public copyFrom(other: Store, thisOffset: Integer, otherOffset: Integer, length: Integer): undefined source

Copy data from one store to another

Params:

Name	Type	Attribute	Description
other	Store		store to copy from
thisOffset	Integer		offset to start copying to
otherOffset	Integer		offset to start copying from
length	Integer		number of entries to copy

Return:

public copyWithin(thisOffset: Integer, otherOffset: Integer, length: Integer): undefined source

Copy data within this store

Params:

Name	Type	Attribute	Description
thisOffset	Integer		offset to start copying to
otherOffset	Integer		offset to start copying from
length	Integer		number of entries to copy

Return:

public dispose(): undefined source

Dispose of the store entries and fields

Return:

public growIfFull(): undefined source

Resize the store to 1.5 times its current size if full

Return:

public resize(size: Integer): undefined source

Resize the store to the new size

Params:

Name	Type	Attribute	Description
size	Integer		new size

Return:

public sort(compareFunction: [type]): undefined source

Sort entries in the store given the compare function

Params:

Name	Type	Attribute	Description
compareFunction	[type]		function to sort by

Return:

Private Methods

private _init(size: Integer): undefined source

Initialize the store

Params:

Name	Type	Attribute	Description
size	Integer		size to initialize

Return:

private _initField(name: String, size: Integer, type: String): undefined source

Initialize a field

Params:

Name	Type	Attribute	Description
name	String		field name
size	Integer		element size
type	String		data type, one of int8, int16, int32, uint8, uint16, uint32, float32

Return: