bmbuilder

README

BM Builder

BM Builder is a library that generates a BondMachine architecture file from a set of already existing BondMachines by combining them. BM Builder is a tool that is part of the BondMachine toolchain. It works by layering the BondMachines on top of each other, and then combining them into a single BondMachine. It is used with its companion CLI tool, called in the same way, bmbuilder, or used as a library in other tools as for example in the bmqsim tool.

Generators

• Maxpool generator

Documentation

Index

• Constants
• func BasmGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)
• func CnotGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)
• func GetPassMnemonic() map[uint64]string
• func HadamardGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)
• func IsOptionalPass() map[uint64]bool
• func MaxPoolGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)
• func ZeroGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)
• type BMBuilder
  • func (bi *BMBuilder) ActivePass(active uint64) bool
  • func (bi *BMBuilder) Alert(logline ...interface{})
  • func (bld *BMBuilder) BMBuilderInit()
  • func (bld *BMBuilder) BMMerge(bm1 *bondmachine.Bondmachine, bm2 *bondmachine.Bondmachine, l *BMConnections) (*bondmachine.Bondmachine, error)
  • func (bi *BMBuilder) BuildBondMachine() error
  • func (bi *BMBuilder) BuildSequentialBlock(block *BMBuilderBlock) error
  • func (bi *BMBuilder) Debug(logline ...interface{})
  • func (bi *BMBuilder) ExportBasmBody() (*bmline.BasmBody, error)
  • func (bi *BMBuilder) GetBondMachine() *bondmachine.Bondmachine
  • func (bi *BMBuilder) Info(logline ...interface{})
  • func (bld *BMBuilder) ParseBuilderDefault(filePath string) error
  • func (bld *BMBuilder) ParseBuilderFile(filePath string, parseFunction func(*BMBuilder, string, uint32) error) error
  • func (bld *BMBuilder) ParseBuilderString(text string, parseFunction func(*BMBuilder, string, uint32) error) error
  • func (bi *BMBuilder) RunBuilder() error
  • func (bi *BMBuilder) SetActive(pass string) error
  • func (bld *BMBuilder) SetDebug()
  • func (bld *BMBuilder) SetVerbose()
  • func (bi *BMBuilder) String() string
  • func (bi *BMBuilder) UnsetActive(pass string) error
  • func (bi *BMBuilder) Warning(logline ...interface{})
• type BMBuilderBlock
  • func (m *BMBuilderBlock) String() string
• type BMConnections
  • func ConnectorDefault(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*BMConnections, error)
  • func (c *BMConnections) String() string
• type BMEndPoint
  • func (e BMEndPoint) String() string
• type BMLink
• type Connector
• type Generator

Constants

const (
	FinalBMInput = uint8(1) + iota
	FinalBMOutput
	FirstBMInput
	FirstBMOutput
	SecondBMInput
	SecondBMOutput
)

const (
	LAST_PASS = passGeneratorsExec
)

Functions

func BasmGenerator

func BasmGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)

func CnotGenerator

func CnotGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)

func GetPassMnemonic

func GetPassMnemonic() map[uint64]string

func HadamardGenerator

func HadamardGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)

func IsOptionalPass

func IsOptionalPass() map[uint64]bool

func MaxPoolGenerator

func MaxPoolGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)

func ZeroGenerator

func ZeroGenerator(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*bondmachine.Bondmachine, error)

Types

type BMBuilder

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

The instance

func (*BMBuilder) ActivePass

func (bi *BMBuilder) ActivePass(active uint64) bool

func (*BMBuilder) Alert

func (bi *BMBuilder) Alert(logline ...interface{})

Alert helper function

func (*BMBuilder) BMBuilderInit

func (bld *BMBuilder) BMBuilderInit()

func (*BMBuilder) BMMerge

func (bld *BMBuilder) BMMerge(bm1 *bondmachine.Bondmachine, bm2 *bondmachine.Bondmachine, l *BMConnections) (*bondmachine.Bondmachine, error)

func (*BMBuilder) BuildBondMachine

func (bi *BMBuilder) BuildBondMachine() error

func (*BMBuilder) BuildSequentialBlock

func (bi *BMBuilder) BuildSequentialBlock(block *BMBuilderBlock) error

func (*BMBuilder) Debug

func (bi *BMBuilder) Debug(logline ...interface{})

Debug helper functrion

func (*BMBuilder) ExportBasmBody

func (bi *BMBuilder) ExportBasmBody() (*bmline.BasmBody, error)

func (*BMBuilder) GetBondMachine

func (bi *BMBuilder) GetBondMachine() *bondmachine.Bondmachine

func (*BMBuilder) Info

func (bi *BMBuilder) Info(logline ...interface{})

Info helper function

func (*BMBuilder) ParseBuilderDefault

func (bld *BMBuilder) ParseBuilderDefault(filePath string) error

func (*BMBuilder) ParseBuilderFile

func (bld *BMBuilder) ParseBuilderFile(filePath string, parseFunction func(*BMBuilder, string, uint32) error) error

ParseBuilderFile opens the actual assembly file and call a parse function on every line with the underline BMBuilder loaded

func (*BMBuilder) ParseBuilderString

func (bld *BMBuilder) ParseBuilderString(text string, parseFunction func(*BMBuilder, string, uint32) error) error

ParseBuilderString opens the actual assembly file and call a parse function on every line with the underline BMBuilder loaded

func (*BMBuilder) RunBuilder

func (bi *BMBuilder) RunBuilder() error

func (*BMBuilder) SetActive

func (bi *BMBuilder) SetActive(pass string) error

func (*BMBuilder) SetDebug

func (bld *BMBuilder) SetDebug()

SetDebug sets the debug flag on a BMBuilder

func (*BMBuilder) SetVerbose

func (bld *BMBuilder) SetVerbose()

SetVerbose sets the verbose flag on a BMBuilder

func (*BMBuilder) String

func (bi *BMBuilder) String() string

func (*BMBuilder) UnsetActive

func (bi *BMBuilder) UnsetActive(pass string) error

func (*BMBuilder) Warning

func (bi *BMBuilder) Warning(logline ...interface{})

Warning helper function

type BMBuilderBlock

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

func (*BMBuilderBlock) String

func (m *BMBuilderBlock) String() string

type BMConnections

type BMConnections struct {
	Links []BMLink
}

func ConnectorDefault

func ConnectorDefault(b *BMBuilder, e *bmline.BasmElement, l *bmline.BasmLine) (*BMConnections, error)

func (*BMConnections) String

func (c *BMConnections) String() string

type BMEndPoint

type BMEndPoint struct {
	BType uint8
	BNum  int
}

func (BMEndPoint) String

func (e BMEndPoint) String() string

type BMLink

type BMLink struct {
	E1 BMEndPoint
	E2 BMEndPoint
}

type Connector

type Connector func(*BMBuilder, *bmline.BasmElement, *bmline.BasmLine) (*BMConnections, error)

type Generator

type Generator func(*BMBuilder, *bmline.BasmElement, *bmline.BasmLine) (*bondmachine.Bondmachine, error)