GraphBLAS

README

Caudex GraphBLAS

A sparse linear algebra library

Supports float32 and float64 types

Documentation

Index

• func NewContext(ctx context.Context, mode Mode) context.Context
• type Context
• type EmptyMask
  • func NewEmptyMask(r, c int) *EmptyMask
  • func (s *EmptyMask) Columns() int
  • func (s *EmptyMask) Element(r, c int) bool
  • func (s *EmptyMask) Rows() int
• type Mask
• type Mode
  • func BlockingMode(ctx context.Context) (Mode, bool)
• type Type

Functions

func NewContext

func NewContext(ctx context.Context, mode Mode) context.Context

NewContext returns a Context

Types

type Context

type Context interface {
	context.Context
	Mode() Mode
}

Context exends the standard context to include Mode

type EmptyMask

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

EmptyMask is a mask with no elements but will always returns false

func NewEmptyMask

func NewEmptyMask(r, c int) *EmptyMask

NewEmptyMask returns a EmptyMask

func (*EmptyMask) Columns

func (s *EmptyMask) Columns() int

Columns the number of columns of the mask

func (*EmptyMask) Element

func (s *EmptyMask) Element(r, c int) bool

Element of the mask for each tuple that exists in the matrix for which the value of the tuple cast to Boolean is true

func (*EmptyMask) Rows

func (s *EmptyMask) Rows() int

Rows the number of rows of the mask

type Mask

type Mask interface {
	// Columns the number of columns of the mask
	Columns() int

	// Rows the number of rows of the mask
	Rows() int

	// Element of the mask for each tuple that exists in the matrix for which the value of the tuple cast to Boolean is true
	Element(r, c int) bool
}

Mask is used to control how computed values are stored in the output from a method

type Mode

type Mode = int

Mode for blocking

const (
	// Blocking until each method has completed
	Blocking Mode = iota
	// NonBlocking may execute methods in any order
	NonBlocking
)

func BlockingMode

func BlockingMode(ctx context.Context) (Mode, bool)

BlockingMode returns the Mode from the context

type Type

type Type uint

Type user-defined scalar type