Birch Documentation
dot
Initializing search
    lawmurray/Birch
    lawmurray/Birch
    • Birch
        • Cairo package
          • Context
          • Pattern
          • Surface
          • SurfacePDF
          • SurfacePNG
          • SurfaceSVG
          • Cairo package
            • Context
            • Pattern
            • Surface
            • SurfacePDF
            • SurfacePNG
            • SurfaceSVG
            • create
            • createLinear
            • createPDF
            • createPNG
            • createRGB
            • createRGBA
            • createRadial
            • createSVG
          • create
          • createLinear
          • createPDF
          • createPNG
          • createRGB
          • createRGBA
          • createRadial
          • createSVG
        • SQLite package
          • SQLite3
          • SQLite3Statement
          • SQLite package
            • SQLite3
            • SQLite3Statement
        • Birch Standard Library
          • AddDiscreteDeltaDistribution
          • AliveParticleFilter
          • ArgsVisitor
          • Array
          • BernoulliDistribution
          • BetaBernoulliDistribution
          • BetaBinomialDistribution
          • BetaDistribution
          • BetaNegativeBinomialDistribution
          • BinomialDistribution
          • BoundedDiscreteDistribution
          • BoxedForm
          • BoxedValue
          • Buffer
          • CategoricalDistribution
          • ConwayMaxwellPoissonDistribution
          • Delay
          • DeltaDistribution
          • DirichletCategoricalDistribution
          • DirichletDistribution
          • DirichletMultinomialDistribution
          • DiscreteDeltaDistribution
          • DiscreteDistribution
          • Distribution
          • ExponentialDistribution
          • Expression
          • GammaDistribution
          • GammaExponentialDistribution
          • GammaPoissonDistribution
          • GaussianDistribution
          • GaussianGaussianDistribution
          • Handler
          • InputStream
          • InverseGammaDistribution
          • InverseGammaGammaDistribution
          • InverseWishartDistribution
          • Iterator
          • JSONReader
          • JSONWriter
          • Kernel
          • LangevinKernel
          • List
          • MatrixGaussianDistribution
          • MatrixNormalInverseWishartDistribution
          • MatrixNormalInverseWishartMatrixGaussianDistribution
          • MatrixNormalInverseWishartMultivariateGaussianDistribution
          • MatrixTDistribution
          • Model
          • MoveVisitor
          • MultinomialDistribution
          • MultivariateGaussianDistribution
          • MultivariateGaussianGaussianDistribution
          • MultivariateGaussianMultivariateGaussianDistribution
          • MultivariateNormalInverseGammaDistribution
          • MultivariateNormalInverseGammaGaussianDistribution
          • MultivariateNormalInverseGammaMultivariateGaussianDistribution
          • MultivariateNormalInverseWishartDistribution
          • MultivariateNormalInverseWishartMultivariateGaussianDistribution
          • MultivariateTDistribution
          • NegateDiscreteDeltaDistribution
          • NegativeBinomialDistribution
          • NormalInverseGammaDistribution
          • NormalInverseGammaGaussianDistribution
          • Object
          • OutputStream
          • PackExpression
          • ParticleFilter
          • ParticleSampler
          • PoissonDistribution
          • ProgressBar
          • RaggedArray
          • Random
          • Reader
          • RestaurantCategoricalDistribution
          • RestaurantDistribution
          • Stack
          • StackExpression
          • StudentDistribution
          • SubtractDiscreteDeltaDistribution
          • Tape
          • UniformDistribution
          • UniformIntegerDistribution
          • WeibullDistribution
          • WishartDistribution
          • Writer
          • YAMLReader
          • YAMLWriter
          • Birch Standard Library
            • AddDiscreteDeltaDistribution
            • AliveParticleFilter
            • ArgsVisitor
            • Array
            • BernoulliDistribution
            • BetaBernoulliDistribution
            • BetaBinomialDistribution
            • BetaDistribution
            • BetaNegativeBinomialDistribution
            • BinomialDistribution
            • BoundedDiscreteDistribution
            • BoxedForm
            • BoxedValue
            • Buffer
            • CategoricalDistribution
            • ConwayMaxwellPoissonDistribution
            • Delay
            • DeltaDistribution
            • DirichletCategoricalDistribution
            • DirichletDistribution
            • DirichletMultinomialDistribution
            • DiscreteDeltaDistribution
            • DiscreteDistribution
            • Distribution
            • ExponentialDistribution
            • Expression
            • GammaDistribution
            • GammaExponentialDistribution
            • GammaPoissonDistribution
            • GaussianDistribution
            • GaussianGaussianDistribution
            • Handler
            • InputStream
            • InverseGammaDistribution
            • InverseGammaGammaDistribution
            • InverseWishartDistribution
            • Iterator
            • JSONReader
            • JSONWriter
            • Kernel
            • LangevinKernel
            • List
            • MatrixGaussianDistribution
            • MatrixNormalInverseWishartDistribution
            • MatrixNormalInverseWishartMatrixGaussianDistribution
            • MatrixNormalInverseWishartMultivariateGaussianDistribution
            • MatrixTDistribution
            • Model
            • MoveVisitor
            • MultinomialDistribution
            • MultivariateGaussianDistribution
            • MultivariateGaussianGaussianDistribution
            • MultivariateGaussianMultivariateGaussianDistribution
            • MultivariateNormalInverseGammaDistribution
            • MultivariateNormalInverseGammaGaussianDistribution
            • MultivariateNormalInverseGammaMultivariateGaussianDistribution
            • MultivariateNormalInverseWishartDistribution
            • MultivariateNormalInverseWishartMultivariateGaussianDistribution
            • MultivariateTDistribution
            • NegateDiscreteDeltaDistribution
            • NegativeBinomialDistribution
            • NormalInverseGammaDistribution
            • NormalInverseGammaGaussianDistribution
            • Object
            • OutputStream
            • PackExpression
            • ParticleFilter
            • ParticleSampler
            • PoissonDistribution
            • ProgressBar
            • RaggedArray
            • Random
            • Reader
            • RestaurantCategoricalDistribution
            • RestaurantDistribution
            • Stack
            • StackExpression
            • StudentDistribution
            • SubtractDiscreteDeltaDistribution
            • Tape
            • UniformDistribution
            • UniformIntegerDistribution
            • WeibullDistribution
            • WishartDistribution
            • Writer
            • YAMLReader
            • YAMLWriter
            • Bernoulli
            • Beta
            • Binomial
            • Categorical
            • ConwayMaxwellPoisson
            • Delta
            • Dirichlet
            • Exponential
            • Gamma
            • Gaussian
            • Geometric
            • InverseGamma
            • InverseWishart
            • MatrixGaussian
            • Multinomial
            • MultivariateGaussian
            • NegativeBinomial
            • Poisson
            • Restaurant
            • Student
            • Uniform
            • UniformInteger
            • Weibull
            • Wishart
            • abs
            • acos
            • adjacent_difference
            • asin
            • atan
            • box
            • bridge
            • cast
            • ceil
            • chol
            • cholinv
            • cholsolve
            • collect
            • column
            • copy
            • copysign
            • cos
            • cosh
            • count
            • diagonal
            • dot
            • dump
            • element
            • error
            • exclusive_scan
            • exp
            • expm1
            • extension
            • floor
            • fopen
            • for_each
            • frobenius
            • from_string
            • gather
            • hadamard
            • identity
            • inclusive_scan
            • init
            • inner
            • inv
            • iota
            • is_sorted
            • isfinite
            • isinf
            • isnan
            • lbeta
            • lbinomial
            • lcholdet
            • ldet
            • length
            • lfact
            • lgamma
            • log
            • ltridet
            • make
            • make_buffer
            • make_input_stream
            • make_output_stream
            • make_random
            • make_reader
            • make_writer
            • mat
            • matrix
            • matrix_lambda
            • max
            • min
            • mkdir
            • mod
            • outer
            • pack
            • pow
            • rect
            • reduce
            • round
            • row
            • scatter
            • seed
            • sin
            • single
            • sinh
            • slurp
            • sort
            • sort_index
            • sqrt
            • stack
            • sum
            • tan
            • tanh
            • term
            • tic
            • to_string
            • toc
            • transform
            • transform_reduce
            • transpose
            • triinner
            • triinnersolve
            • triinv
            • trimul
            • triouter
            • trisolve
            • vec
            • vector
            • vector_lambda
            • wait
            • warn
            • where
            • wrap
            • + (binary)
            • &&
            • /
            • ==
            • >=
            • >
            • <=
            • <
            • *
            • !=
            • - (unary)
            • !
            • ||
            • + (unary)
            • - (binary)
            • audit
            • bootstrap
            • build
            • clean
            • configure
            • dist
            • docs
            • filter
            • help
            • init
            • install
            • sample
            • uninstall
            • Add
            • Binary
            • Form
            • Mul
            • Neg
            • Sub
            • Ternary
            • Unary
            • Boolean
            • BooleanLike
            • BooleanMatrixLike
            • BooleanScalarLike
            • BooleanVectorLike
            • File
            • Integer
            • IntegerLike
            • IntegerMatrixLike
            • IntegerScalarLike
            • IntegerVectorLike
            • NumberLike
            • NumberMatrixLike
            • NumberScalarLike
            • NumberVectorLike
            • Real
            • RealLike
            • RealMatrixLike
            • RealScalarLike
            • RealVectorLike
            • String
            • Variables
          • Bernoulli
          • Beta
          • Binomial
          • Categorical
          • ConwayMaxwellPoisson
          • Delta
          • Dirichlet
          • Exponential
          • Gamma
          • Gaussian
          • Geometric
          • InverseGamma
          • InverseWishart
          • MatrixGaussian
          • Multinomial
          • MultivariateGaussian
          • NegativeBinomial
          • Poisson
          • Restaurant
          • Student
          • Uniform
          • UniformInteger
          • Weibull
          • Wishart
          • abs
          • acos
          • adjacent_difference
          • asin
          • atan
          • box
          • bridge
          • cast
          • ceil
          • chol
          • cholinv
          • cholsolve
          • collect
          • column
          • copy
          • copysign
          • cos
          • cosh
          • count
          • diagonal
          • dot
          • dump
          • element
          • error
          • exclusive_scan
          • exp
          • expm1
          • extension
          • floor
          • fopen
          • for_each
          • frobenius
          • from_string
          • gather
          • hadamard
          • identity
          • inclusive_scan
          • init
          • inner
          • inv
          • iota
          • is_sorted
          • isfinite
          • isinf
          • isnan
          • lbeta
          • lbinomial
          • lcholdet
          • ldet
          • length
          • lfact
          • lgamma
          • log
          • ltridet
          • make
          • make_buffer
          • make_input_stream
          • make_output_stream
          • make_random
          • make_reader
          • make_writer
          • mat
          • matrix
          • matrix_lambda
          • max
          • min
          • mkdir
          • mod
          • outer
          • pack
          • pow
          • rect
          • reduce
          • round
          • row
          • scatter
          • seed
          • sin
          • single
          • sinh
          • slurp
          • sort
          • sort_index
          • sqrt
          • stack
          • sum
          • tan
          • tanh
          • term
          • tic
          • to_string
          • toc
          • transform
          • transform_reduce
          • transpose
          • triinner
          • triinnersolve
          • triinv
          • trimul
          • triouter
          • trisolve
          • vec
          • vector
          • vector_lambda
          • wait
          • warn
          • where
          • wrap
          • + (binary)
          • &&
          • /
          • ==
          • >=
          • >
          • <=
          • <
          • *
          • !=
          • - (unary)
          • !
          • ||
          • + (unary)
          • - (binary)
          • audit
          • bootstrap
          • build
          • clean
          • configure
          • dist
          • docs
          • filter
          • help
          • init
          • install
          • sample
          • uninstall
          • Add
          • Binary
          • Form
          • Mul
          • Neg
          • Sub
          • Ternary
          • Unary
          • Boolean
          • BooleanLike
          • BooleanMatrixLike
          • BooleanScalarLike
          • BooleanVectorLike
          • File
          • Integer
          • IntegerLike
          • IntegerMatrixLike
          • IntegerScalarLike
          • IntegerVectorLike
          • NumberLike
          • NumberMatrixLike
          • NumberScalarLike
          • NumberVectorLike
          • Real
          • RealLike
          • RealMatrixLike
          • RealScalarLike
          • RealVectorLike
          • String
          • Variables

    dot


    function dot(x:RealVectorLike, y:RealVectorLike) -> RealScalarLike

    Vector-vector dot product.

    • x Vector x.
    • y Vector y.

    Returns Result x^\top y as a scalar.

    function dot(x:RealVectorLike) -> RealScalarLike

    Vector dot product.

    • x Vector x.

    Returns Result x^\top x as a scalar.

    Made with Material for MkDocs