ant

Documentation

Overview

Copyright (c) 2024 Sebastian Kroczek <me@xbug.de>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2024 Sebastian Kroczek <me@xbug.de>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2024 Sebastian Kroczek <me@xbug.de>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2024 Sebastian Kroczek <me@xbug.de>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type Adjustments
  • func (a Adjustments) IsValid() bool
• type Ant
• type AntConstructor
• type AntOs
• type ChooseRole
• type Level
• type Mark
• type Roles
• type RolesCount
• type Sugar
• type UnimplementedAnt
  • func (d *UnimplementedAnt) ReachedSugar(sugar Sugar)
  • func (d *UnimplementedAnt) SeeFriend(ant Ant)
  • func (d *UnimplementedAnt) SeeMark(mark Mark)
  • func (d *UnimplementedAnt) SeeSugar(sugar Sugar)
  • func (d *UnimplementedAnt) Tick()
  • func (d *UnimplementedAnt) Waits()

Types

type Adjustments

type Adjustments struct {
	Speed    Level
	Rotation Level
	Load     Level
	Vision   Level
	Range    Level
	Energy   Level
	Attack   Level
}

func (Adjustments) IsValid

func (a Adjustments) IsValid() bool

type Ant

type Ant interface {
	Waits()
	SeeSugar(Sugar)
	ReachedSugar(Sugar)
	SeeFriend(Ant)
	SeeMark(Mark)
	Tick()
}

type AntConstructor

type AntConstructor func(AntOs) interface{}

type AntOs

type AntOs interface {
	GetId() int
	GetRole() string
	GetCurrentLoad() int
	GetDirectionToSugar(sugar Sugar) int
	GoForwards()
	GoForward(int)
	Turn(int)
	GoToSugar(sugar Sugar)
	TakeSugar(sugar Sugar) error
	GotToAntHill()
	SetMark(radius int, information int)
}

type ChooseRole

type ChooseRole func(RolesCount) string

type Level

type Level int

const (
	Decreased Level = iota - 1
	Default
	Increased
	Boosted
)

type Mark

type Mark interface {
	GetInformation() int
}

type Roles

type Roles map[string]Adjustments

type RolesCount

type RolesCount map[string]int

type Sugar

type Sugar interface {
	GetCurrentSugar() int
}

type UnimplementedAnt

type UnimplementedAnt struct {
}

UnimplementedAnt is a dummy implementation of the Ant interface It does nothing and is used to satisfy the interface when no real implementation is needed for example in tests or the default AntConstructor (@see simulation.NewSimulationConfig)

func (*UnimplementedAnt) ReachedSugar

func (d *UnimplementedAnt) ReachedSugar(sugar Sugar)

func (*UnimplementedAnt) SeeFriend

func (d *UnimplementedAnt) SeeFriend(ant Ant)

func (*UnimplementedAnt) SeeMark

func (d *UnimplementedAnt) SeeMark(mark Mark)

func (*UnimplementedAnt) SeeSugar

func (d *UnimplementedAnt) SeeSugar(sugar Sugar)

func (*UnimplementedAnt) Tick

func (d *UnimplementedAnt) Tick()

func (*UnimplementedAnt) Waits

func (d *UnimplementedAnt) Waits()