master > master: code go - cleanup von cli + option, um checks ein+auszuschalten

code/golang/internal/algorithms/search/binary/binary_fancy.go

@@ -64,13 +64,19 @@ func FancyBinarySearch(input_L []int, input_x int) (int, error) {
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L, input_x)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L, input_x)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -79,14 +85,20 @@ func FancyBinarySearch(input_L []int, input_x int) (int, error) {
 			"index": output_index,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, input_x, output_index)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, input_x, output_index)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 

code/golang/internal/algorithms/search/interpol/interpol_fancy.go

@@ -66,13 +66,19 @@ func FancyInterpolationSearch(input_L []int, input_x int, input_u int, input_v i
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L, input_x, input_u, input_v)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L, input_x, input_u, input_v)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -81,14 +87,20 @@ func FancyInterpolationSearch(input_L []int, input_x int, input_u int, input_v i
 			"index": output_index,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, input_x, output_index)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, input_x, output_index)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 

code/golang/internal/algorithms/search/ith_element/ith_element_fancy.go

@@ -61,13 +61,19 @@ func FancyFindIthSmallest(input_L []int, input_i int) (int, error) {
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L, input_i)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L, input_i)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -76,14 +82,20 @@ func FancyFindIthSmallest(input_L []int, input_i int) (int, error) {
 			"value": output_value,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, input_i, output_value)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, input_i, output_value)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 
@@ -109,13 +121,19 @@ func FancyFindIthSmallestDC(input_L []int, input_i int) (int, error) {
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L, input_i)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L, input_i)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -124,14 +142,20 @@ func FancyFindIthSmallestDC(input_L []int, input_i int) (int, error) {
 			"value": output_value,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, input_i, output_value)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, input_i, output_value)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 

code/golang/internal/algorithms/search/jump/jump_fancy.go

@@ -65,13 +65,19 @@ func FancyJumpSearchLinear(input_L []int, input_x int, input_m int) (int, error)
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L, input_x, input_m)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L, input_x, input_m)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -80,14 +86,20 @@ func FancyJumpSearchLinear(input_L []int, input_x int, input_m int) (int, error)
 			"index": output_index,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, input_x, output_index)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, input_x, output_index)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 
@@ -113,13 +125,19 @@ func FancyJumpSearchExponentiell(input_L []int, input_x int) (int, error) {
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L, input_x)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L, input_x)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -128,14 +146,20 @@ func FancyJumpSearchExponentiell(input_L []int, input_x int) (int, error) {
 			"index": output_index,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, input_x, output_index)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, input_x, output_index)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 

code/golang/internal/algorithms/search/poison/poison_fancy.go

@@ -59,13 +59,19 @@ func FancyFindPoison(input_L []int) (int, error) {
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -74,14 +80,20 @@ func FancyFindPoison(input_L []int) (int, error) {
 			"index": output_index,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, output_index)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, output_index)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 
@@ -106,13 +118,19 @@ func FancyFindPoisonFast(input_L []int) (int, error) {
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -121,14 +139,20 @@ func FancyFindPoisonFast(input_L []int) (int, error) {
 			"index": output_index,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, output_index)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, output_index)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 

code/golang/internal/algorithms/search/sequential/sequential_fancy.go

@@ -62,13 +62,19 @@ func FancySequentialSearch(input_L []int, input_x int) (int, error) {
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L, input_x)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L, input_x)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -77,14 +83,20 @@ func FancySequentialSearch(input_L []int, input_x int) (int, error) {
 			"index": output_index,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, input_x, output_index)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, input_x, output_index)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 

code/golang/internal/algorithms/sum/maxsubsum/maxsubsum_fancy.go

@@ -53,13 +53,19 @@ func FancyMaxSubSum(input_L []int) (int, int, int, error) {
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -70,14 +76,20 @@ func FancyMaxSubSum(input_L []int) (int, int, int, error) {
 			"index_to":   output_indexTo,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, output_maxSum, output_indexFrom, output_indexTo)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, output_maxSum, output_indexFrom, output_indexTo)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 
@@ -104,13 +116,19 @@ func FancyMaxSubSumDC(input_L []int) (int, int, int, error) {
 	do_once := true
 	for do_once {
 		do_once = false
+
+		// Start Message
 		setup.DisplayStartOfAlgorithm(name, inputs)
+
+		// Metriken initialisieren
 		metrics.RestartMetrics()
 
 		// Prechecks:
-		err = preChecks(input_L)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = preChecks(input_L)
-			break
+			if err != nil {
+				break
+			}
 		}
 
 		// Ausführung des Algorithmus:
@@ -121,14 +139,20 @@ func FancyMaxSubSumDC(input_L []int) (int, int, int, error) {
 			"index_to":   output_indexTo,
 		}
 
-		// Letzte Messages:
+		// Metriken anzeigen
-		setup.DisplayMetrics()
+		if setup.AppConfigShowMetrics() {
+			setup.DisplayMetrics()
+		}
+
+		// End Message
 		setup.DisplayEndOfAlgorithm(outputs)
 
 		// Postchecks:
-		err = postChecks(input_L, output_maxSum, output_indexFrom, output_indexTo)
+		if setup.AppConfigPerformChecks() {
-		if err != nil {
+			err = postChecks(input_L, output_maxSum, output_indexFrom, output_indexTo)
-			break
+			if err != nil {
+				break
+			}
 		}
 	}
 

code/golang/internal/core/utils/utils_strings.go

@@ -94,3 +94,17 @@ func FormatTextBlockAsList(text string, options ...bool) []string {
 func StripAnsi(text string) string {
 	return re.Sub(`\x1b[^m]*m`, ``, text)
 }
+
+/* ---------------------------------------------------------------- *
+ * METHODS string -> bool
+ * ---------------------------------------------------------------- */
+
+func IsTrue(text string) bool {
+	text = strings.TrimSpace(text)
+	return re.Matches(`(?i)(^(true|t|yes|y|1|\+|\+1)$)`, text)
+}
+
+func IsFalse(text string) bool {
+	text = strings.TrimSpace(text)
+	return re.Matches(`(?i)(^(false|f|no|n|0|-|-1)$)`, text)
+}

code/golang/internal/endpoints/endpoints_print.go

@@ -7,6 +7,7 @@ package endpoints
 import (
 	"ads/internal/core/logging"
 	"ads/internal/setup"
+	"ads/internal/setup/cli"
 )
 
 /* ---------------------------------------------------------------- *
@@ -24,11 +25,12 @@ func Version() {
 
 func Help() {
 	logging.SetForce(true)
+	cli.ParseCli([]string{}) // <- generiere leere Instanz für Parser, um voll Hilfsanleitug zu zeigen
 	logging.LogPlain(
 		"",
 		setup.Logo(),
-		// cli.Parser.Usage(nil),
+		// 	setup.Help(),
-		setup.Help(),
+		cli.Parser.Usage(nil),
 		"",
 	)
 }

code/golang/internal/setup/cli/cli.go

@@ -26,6 +26,13 @@ var optionsQuiet = argparse.Options{
 	Default:  false,
 }
 
+var optionsChecks = argparse.Options{
+	Help:     "Ob vor und nach Ausführung von Algorithmen Checks auf Inputs/Outputs ausgeführt werden sollen.",
+	Required: false,
+	// NOTE: no `Boolean` option available!
+	Default: "false",
+}
+
 var optionsDebug = argparse.Options{
 	Help:     "Blendet die Debugging-Befehle ein.",
 	Required: false,
@@ -33,7 +40,7 @@ var optionsDebug = argparse.Options{
 }
 
 var optionsColour = argparse.Options{
-	Help:     "Ob Logging färblich angezeigt wird (default=true).",
+	Help:     "Ob Logging färblich angezeigt wird.",
 	Required: false,
 	// NOTE: no `Boolean` option available!
 	Default: "true",
@@ -58,6 +65,7 @@ func ParseCli(args []string) (*types.CliArguments, error) {
 		Run:        Parser.NewCommand("run", "Ruft Endpunkt auf, der die Algorithmen laufen lässt."),
 		Quiet:      Parser.Flag("q", "quiet", &optionsQuiet),
 		Debug:      Parser.Flag("", "debug", &optionsDebug),
+		Checks:     Parser.String("", "checks", &optionsChecks),
 		Colour:     Parser.String("", "colour", &optionsColour),
 		ConfigFile: Parser.String("", "config", &optionsConfigFile),
 	}

code/golang/internal/setup/setup_appconfig.go

@@ -0,0 +1,40 @@
+package setup
+
+/* ---------------------------------------------------------------- *
+ * IMPORTS
+ * ---------------------------------------------------------------- */
+
+import (
+	"ads/internal/types"
+
+	"gopkg.in/yaml.v3"
+)
+
+/* ---------------------------------------------------------------- *
+ * GLOBAL CONSTANTS
+ * ---------------------------------------------------------------- */
+
+var AppConfig = types.AppConfig{}
+
+/* ---------------------------------------------------------------- *
+ * METHODS
+ * ---------------------------------------------------------------- */
+
+// Extrahiert Inhalte einer YAML Config und parset dies als Struktur
+func AppConfigInitialise() error {
+	contents := AppConfigYaml()
+	err := yaml.Unmarshal([]byte(contents), &AppConfig)
+	return err
+}
+
+func AppConfigFancyMode() bool {
+	return AppConfig.Options.Display
+}
+
+func AppConfigShowMetrics() bool {
+	return AppConfig.Options.Metrics
+}
+
+func AppConfigPerformChecks() bool {
+	return AppConfig.Options.Checks
+}

code/golang/internal/setup/setup_assets.go

@@ -54,3 +54,7 @@ func Logo() string {
 func Version() string {
 	return strings.Trim(ReadAsset("version"), "\n")
 }
+
+func AppConfigYaml() string {
+	return strings.Trim(ReadAsset("appconfig"), "\n")
+}

code/golang/internal/types/types_appconfig.go

@@ -0,0 +1,27 @@
+package types
+
+/* ---------------------------------------------------------------- *
+ * IMPORTS
+ * ---------------------------------------------------------------- */
+
+//
+
+/* ---------------------------------------------------------------- *
+ * YAML SCHEMES
+ * ---------------------------------------------------------------- */
+
+type AppConfig struct {
+	Info    *AppConfigInfo    `yaml:"info"`
+	Options *AppConfigOptions `yaml:"options"`
+}
+
+type AppConfigInfo struct {
+	Title       *string `yaml:"title"`
+	Description *string `yaml:"description"`
+}
+
+type AppConfigOptions struct {
+	Display bool `yaml:"display"`
+	Checks  bool `yaml:"checks"`
+	Metrics bool `yaml:"metrics"`
+}

code/golang/internal/types/types_cli.go

@@ -5,11 +5,9 @@ package types
  * ---------------------------------------------------------------- */
 
 import (
-	"strings"
-
 	"github.com/akamensky/argparse"
 
-	"ads/pkg/re"
+	"ads/internal/core/utils"
 )
 
 /* ---------------------------------------------------------------- *
@@ -22,6 +20,7 @@ type CliArguments struct {
 	Run        *argparse.Command
 	Quiet      *bool
 	Debug      *bool
+	Checks     *string
 	Colour     *string
 	ConfigFile *string
 }
@@ -30,16 +29,22 @@ type CliArguments struct {
  * METHODS convert string option to boolean
  * ---------------------------------------------------------------- */
 
-func IsTrue(text string) bool {
+func (arguments CliArguments) QuietModeOn() bool {
-	text = strings.TrimSpace(text)
+	return *arguments.Quiet
-	return re.Matches(`(?i)(^(true|t|yes|y|1|\+|\+1)$)`, text)
 }
 
-func IsFalse(text string) bool {
+func (arguments CliArguments) DebugModeOn() bool {
-	text = strings.TrimSpace(text)
+	return *arguments.Debug
-	return re.Matches(`(?i)(^(false|f|no|n|0|-|-1)$)`, text)
 }
 
-func (arguments *CliArguments) ShowColour() bool {
+func (arguments CliArguments) ShowChecks() bool {
-	return !IsFalse(*arguments.Colour)
+	return !utils.IsFalse(*arguments.Checks)
+}
+
+func (arguments CliArguments) ShowColour() bool {
+	return !utils.IsFalse(*arguments.Colour)
+}
+
+func (arguments CliArguments) GetConfigFile() string {
+	return *arguments.ConfigFile
 }

code/golang/main.go

@@ -24,9 +24,10 @@ var (
 	//go:embed assets/*
 	res    embed.FS
 	assets = map[string]string{
-		"version": "assets/VERSION",
+		"appconfig": "assets/config.yml",
-		"logo":    "assets/LOGO",
+		"version":   "assets/VERSION",
-		"help":    "assets/HELP",
+		"logo":      "assets/LOGO",
+		"help":      "assets/HELP",
 	}
 )
 
@@ -38,25 +39,34 @@ func main() {
 	var err error
 	var arguments *types.CliArguments
 
-	// set assets
+	// assets festlegen
 	setup.Res = res
 	setup.Assets = assets
 
-	// parse cli arguments
+	// cli arguments parsen
 	arguments, err = cli.ParseCli(os.Args)
 
-	// initialise logging options
+	// initialisiere basic optionen wie Logging
 	if err == nil {
-		logging.SetQuietMode(*arguments.Quiet)
+		logging.SetQuietMode(arguments.QuietModeOn())
-		logging.SetDebugMode(*arguments.Debug)
+		logging.SetDebugMode(arguments.DebugModeOn())
 		logging.SetAnsiMode(arguments.ShowColour())
 	}
 
+	// app config (intern) intialisieren
+	if err == nil {
+		err = setup.AppConfigInitialise()
+	}
+
+	if err == nil {
+		setup.AppConfig.Options.Checks = arguments.ShowChecks()
+	}
+
 	if err == nil {
 		if arguments.Version.Happened() {
 			endpoints.Version()
 		} else if arguments.Run.Happened() {
-			err = endpoints.Run(*arguments.ConfigFile)
+			err = endpoints.Run(arguments.GetConfigFile())
 		} else { // } else if arguments.Help.Happened() {
 			endpoints.Help()
 		}