cmmn

Documentation

Overview

Package pdb/cmmn has common definitions for coordinates and pdb files

Index

• Constants
• Variables
• type Chain
• type ChnSl
  • func (chns ChnSl) ChainNames() (ret []string)
• type CoordSet
• type Xyz
  • func (xyz *Xyz) Ok() bool
• type XyzSl

Constants

const (
	FileSrc byte = iota
	HTTPSrc
)

Does our data come from a file or http source ?

Variables

var BrokenResNum int = -9999

var BrokenXyz = Xyz{math.MaxFloat32, 0, -math.MaxFloat32}

Types

type Chain

type Chain struct {
	ChainID  string // Name, like "A" or "B"
	MdlNum   int16  // Model number
	NumLbl   []int  // residue numbers from file. Not real indices
	InsCode  []byte // Insertion code
	CoordSet CoordSet
}

A simple structure for one model, one chain and a set of xyz coordinates

type ChnSl

type ChnSl []Chain

This is obviously just a slice of chains, but we have to define a type if we want to define a method on it

func (ChnSl) ChainNames

func (chns ChnSl) ChainNames() (ret []string)

ChainNames returns a slice with the names of the chains.

type CoordSet

type CoordSet map[string]XyzSl

type Xyz

type Xyz struct{ X, Y, Z float32 }

func (*Xyz) Ok

func (xyz *Xyz) Ok() bool

type XyzSl

type XyzSl []Xyz // xyz's are coordinates