planner

package

v0.0.0-...-68cc29a Latest Latest Go to latest Published: Jun 2, 2024 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func AverageCost(plan api.Rates) float64

AverageCost returns the time-weighted average cost

func Duration(plan api.Rates) time.Duration

Duration returns the sum of all slot's durations

func IsFirst(r api.Rate, plan api.Rates) bool

IsFirst returns if the slot is the first slot in the plan. Does not require the plan to be sorted by start time.

func SlotAt(time time.Time, plan api.Rates) api.Rate

SlotAt returns the slot for the given time or an empty slot

func SlotHasSuccessor(r api.Rate, plan api.Rates) bool

SlotHasSuccessor returns if the slot has an immediate successor. Does not require the plan to be sorted by start time.

func Start(plan api.Rates) time.Time

Start returns the earliest slot's start time

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

Planner plans a series of charging slots for a given (variable) tariff

func New(log *util.Logger, tariff api.Tariff, opt ...func(t *Planner)) *Planner

New creates a price planner

func (t *Planner) Plan(requiredDuration time.Duration, targetTime time.Time) (api.Rates, error)