database

Documentation

Index

• Variables
• type DB
  • func New(o O) *DB
  • func (db *DB) DeleteAgent(x id.ID)
  • func (db *DB) DeleteFeature(x id.ID)
  • func (db *DB) DeleteProjectile(x id.ID)
  • func (db *DB) GetAgentOrDie(x id.ID) roagent.RO
  • func (db *DB) GetFeatureOrDie(x id.ID) rofeature.RO
  • func (db *DB) GetProjectileOrDie(x id.ID) roprojectile.RO
  • func (db *DB) InsertAgent(o roagent.O) roagent.RO
  • func (db *DB) InsertFeature(o rofeature.O) rofeature.RO
  • func (db *DB) InsertProjectile(o roprojectile.O) roprojectile.RO
  • func (db *DB) ListAgents() <-chan roagent.RO
  • func (db *DB) ListFeatures() <-chan rofeature.RO
  • func (db *DB) ListProjectiles() <-chan roprojectile.RO
  • func (db *DB) QueryAgents(q hyperrectangle.R, filter func(a roagent.RO) bool) []roagent.RO
  • func (db *DB) QueryFeatures(q hyperrectangle.R, filter func(a rofeature.RO) bool) []rofeature.RO
  • func (db *DB) SetAgentHeading(x id.ID, v polar.V)
  • func (db *DB) SetAgentMoveMode(x id.ID, f move.F)
  • func (db *DB) SetAgentPosition(x id.ID, v vector.V)
  • func (db *DB) SetAgentTargetPosition(x id.ID, v vector.V)
  • func (db *DB) SetAgentTargetVelocity(x id.ID, v vector.V)
  • func (db *DB) SetAgentVelocity(x id.ID, v vector.V)
  • func (db *DB) SetProjectileHeading(x id.ID, v polar.V)
  • func (db *DB) SetProjectilePosition(x id.ID, v vector.V)
  • func (db *DB) SetProjectileTargetPosition(x id.ID, v vector.V)
  • func (db *DB) SetProjectileTargetVelocity(x id.ID, v vector.V)
  • func (db *DB) SetProjectileVelocity(x id.ID, v vector.V)
• type O
• type RO

Variables

var (
	// DefaultO provides a default set of options for setting up the
	// database. The values here are tailored to an N = 1000 simulation, and
	// is dependent on a variety of factors, e.g. surface area coverage.
	DefaultO = O{
		LeafSize:  8,
		Tolerance: 1.15,
	}
)

Types

type DB

type DB struct {
	// contains filtered or unexported fields
}

func New

func New(o O) *DB

func (*DB) DeleteAgent

func (db *DB) DeleteAgent(x id.ID)

DeleteAgent mutates the DB and must be called serially.

func (*DB) DeleteFeature

func (db *DB) DeleteFeature(x id.ID)

DeleteFeature mutates the DB and must be called serially.

func (*DB) DeleteProjectile

func (db *DB) DeleteProjectile(x id.ID)

DeleteProjectile mutates the DB and must be called serially.

func (*DB) GetAgentOrDie

func (db *DB) GetAgentOrDie(x id.ID) roagent.RO

GetAgentOrDie is a read-only operation and may be called concurrently with other read-only operations.

func (*DB) GetFeatureOrDie

func (db *DB) GetFeatureOrDie(x id.ID) rofeature.RO

GetFeatureOrDie is a read-only operation and may be called concurrently with other read-only operations.

func (*DB) GetProjectileOrDie

func (db *DB) GetProjectileOrDie(x id.ID) roprojectile.RO

GetProjectileOrDie is a read-only operation and may be called concurrently with other read-only operations.

func (*DB) InsertAgent

func (db *DB) InsertAgent(o roagent.O) roagent.RO

InsertAgent mutates the DB and must be called serially.

func (*DB) InsertFeature

func (db *DB) InsertFeature(o rofeature.O) rofeature.RO

InsertFeature mutates the DB and must be called serially.

func (*DB) InsertProjectile

func (db *DB) InsertProjectile(o roprojectile.O) roprojectile.RO

InsertProjectile mutates the DB and must be called serially.

func (*DB) ListAgents

func (db *DB) ListAgents() <-chan roagent.RO

ListAgents returns all agents in the DB. There are serveral use-cases for this method which changes the invocation pattern.

1. Read-only operations on agents may consume this output concurrently.
1. Agent-specific mutations should first iterate over the returned values and create a proposal batch of changes. If these changes do not modify the BVH, they may be run in parallel. Changes to the BVH (e.g. SetAgentPosition) must be done serially.

func (*DB) ListFeatures

func (db *DB) ListFeatures() <-chan rofeature.RO

ListFeatures returns all features in the DB. There are serveral use-cases for this method which changes the invocation pattern.

See ListAgents for more information.

func (*DB) ListProjectiles

func (db *DB) ListProjectiles() <-chan roprojectile.RO

ListProjectiles returns all projectiles in the DB. There are serveral use-cases for this method which changes the invocation pattern.

See ListAgents for more information.

func (*DB) QueryAgents

func (db *DB) QueryAgents(q hyperrectangle.R, filter func(a roagent.RO) bool) []roagent.RO

QueryAgents is a read-only operation and may be called concurrently with other read-only operations.

func (*DB) QueryFeatures

func (db *DB) QueryFeatures(q hyperrectangle.R, filter func(a rofeature.RO) bool) []rofeature.RO

QueryFeatures is a read-only operation and may be called concurrently with other read-only operations.

func (*DB) SetAgentHeading

func (db *DB) SetAgentHeading(x id.ID, v polar.V)

SetAgentHeading does not mutate the BVH and may be called concurrently with calls on other agents.

func (*DB) SetAgentMoveMode

func (db *DB) SetAgentMoveMode(x id.ID, f move.F)

SetAgentMoveMode does not mutate the BVH and may be called concurrently with calls on other agents.

func (*DB) SetAgentPosition

func (db *DB) SetAgentPosition(x id.ID, v vector.V)

SetAgentPosition mutates the BVH and must be called serially.

func (*DB) SetAgentTargetPosition

func (db *DB) SetAgentTargetPosition(x id.ID, v vector.V)

SetAgentTargetPosition does not mutate the BVH and may be called concurrently with calls on other agents.

func (*DB) SetAgentTargetVelocity

func (db *DB) SetAgentTargetVelocity(x id.ID, v vector.V)

SetAgentTargetVelocity does not mutate the BVH and may be called concurrently with calls on other agents.

func (*DB) SetAgentVelocity

func (db *DB) SetAgentVelocity(x id.ID, v vector.V)

SetAgentVelocity does not mutate the BVH and may be called concurrently with calls on other agents.

func (*DB) SetProjectileHeading

func (db *DB) SetProjectileHeading(x id.ID, v polar.V)

SetProjectileHeading does not mutate the BVH and may be called concurrently with calls on other projectiles.

func (*DB) SetProjectilePosition

func (db *DB) SetProjectilePosition(x id.ID, v vector.V)

SetProjectilePosition does not mutate the BVH and may be called concurrently with calls on other projectiles.

func (*DB) SetProjectileTargetPosition

func (db *DB) SetProjectileTargetPosition(x id.ID, v vector.V)

SetProjectileTargetPosition does not mutate the BVH and may be called concurrently with calls on other projectiles.

func (*DB) SetProjectileTargetVelocity

func (db *DB) SetProjectileTargetVelocity(x id.ID, v vector.V)

SetProjectileTargetVelocity does not mutate the BVH and may be called concurrently with calls on other projectiles.

func (*DB) SetProjectileVelocity

func (db *DB) SetProjectileVelocity(x id.ID, v vector.V)

SetProjectileVelocity does not mutate the BVH and may be called concurrently with calls on other projectiles.

type O

type O struct {
	LeafSize  int
	Tolerance float64
}

type RO

type RO interface {
	GetAgentOrDie(x id.ID) roagent.RO
	GetFeatureOrDie(x id.ID) rofeature.RO
	GetProjectileOrDie(x id.ID) roprojectile.RO
	ListAgents() <-chan roagent.RO
	ListFeatures() <-chan rofeature.RO
	ListProjectiles() <-chan roprojectile.RO
	QueryAgents(q hyperrectangle.R, filter func(a roagent.RO) bool) []roagent.RO
	QueryFeatures(q hyperrectangle.R, filter func(a rofeature.RO) bool) []rofeature.RO
}