algorithm

Documentation

Overview

Copyright (c) Ultraviolet SPDX-License-Identifier: Apache-2.0

Copyright (c) Ultraviolet SPDX-License-Identifier: Apache-2.0

Index

• Constants
• func AlgorithmArgsFromContext(ctx context.Context) []string
• func AlgorithmArgsToContext(ctx context.Context, algoArgs []string) context.Context
• func AlgorithmTypeFromContext(ctx context.Context) string
• func AlgorithmTypeToContext(ctx context.Context, algoType string) context.Context
• type AlgorithType
• type Algorithm
• type Stderr
  • func (s *Stderr) Write(p []byte) (n int, err error)
• type Stdout
  • func (s *Stdout) Write(p []byte) (n int, err error)

Constants

const (
	AlgoTypeBin    AlgorithType = "bin"
	AlgoTypePython AlgorithType = "python"
	AlgoTypeWasm   AlgorithType = "wasm"
	AlgoTypeDocker AlgorithType = "docker"
	AlgoTypeKey                 = "algo_type"
	AlgoArgsKey                 = "algo_args"

	ResultsDir     = "results"
	DatasetsDir    = "datasets"
	AlgoWorkingDir = "/cocos"
)

Functions

func AlgorithmArgsFromContext

func AlgorithmArgsFromContext(ctx context.Context) []string

func AlgorithmArgsToContext

func AlgorithmArgsToContext(ctx context.Context, algoArgs []string) context.Context

func AlgorithmTypeFromContext

func AlgorithmTypeFromContext(ctx context.Context) string

func AlgorithmTypeToContext

func AlgorithmTypeToContext(ctx context.Context, algoType string) context.Context

Types

type AlgorithType

type AlgorithType string

type Algorithm

type Algorithm interface {
	// Run executes the algorithm and returns the result.
	Run() error
}

Algorithm is an interface that specifies the API for an algorithm.

type Stderr

type Stderr struct {
	Logger   *slog.Logger
	EventSvc events.Service
}

func (*Stderr) Write

func (s *Stderr) Write(p []byte) (n int, err error)

Write implements io.Writer.

type Stdout

type Stdout struct {
	Logger *slog.Logger
}

func (*Stdout) Write

func (s *Stdout) Write(p []byte) (n int, err error)

Write implements io.Writer.