[revise] Remove Entity and EntitySource

Removes Entity and EntitySource. The solver takes in the Variable Source directly. The constraints, filters, sort or any transformation should be performed on variables before providing it to solver. Signed-off-by: Varsha Prasad Narsing <[email protected]>
operator-framework · Aug 2, 2023 · 7012b3f · 7012b3f
1 parent 35e9eff
commit 7012b3f
Show file tree

Hide file tree

Showing 13 changed files with 117 additions and 239 deletions.
diff --git a/cmd/dimacs/cmd.go b/cmd/dimacs/cmd.go
@@ -53,7 +53,10 @@ func solve(path string) error {
 	}
 
 	// build solver
-	so := solver.NewDeppySolver(NewDimacsEntitySource(dimacs), NewDimacsVariableSource(dimacs))
+	so, err := solver.NewDeppySolver(NewDimacsVariableSource(dimacs))
+	if err != nil {
+		return err
+	}
 
 	// get solution
 	solution, err := so.Solve(context.Background(), solver.AddAllVariablesToSolution())

diff --git a/cmd/dimacs/dimacs_constraints.go b/cmd/dimacs/dimacs_constraints.go
@@ -21,16 +21,13 @@ func NewDimacsVariableSource(dimacs *Dimacs) *ConstraintGenerator {
 	}
 }
 
-func (d *ConstraintGenerator) GetVariables(ctx context.Context, entitySource input.EntitySource) ([]deppy.Variable, error) {
+func (d *ConstraintGenerator) GetVariables(ctx context.Context) ([]deppy.Variable, error) {
 	varMap := make(map[deppy.Identifier]*input.SimpleVariable, len(d.dimacs.variables))
 	variables := make([]deppy.Variable, 0, len(d.dimacs.variables))
-	if err := entitySource.Iterate(ctx, func(entity *input.Entity) error {
-		variable := input.NewSimpleVariable(entity.Identifier())
+
+	for _, id := range d.dimacs.variables {
+		variable := input.NewSimpleVariable(deppy.IdentifierFromString(id))
 		variables = append(variables, variable)
-		varMap[entity.Identifier()] = variable
-		return nil
-	}); err != nil {
-		return nil, err
 	}
 
 	// create constraints out of the clauses

diff --git a/cmd/dimacs/dimacs_source.go b/cmd/dimacs/dimacs_source.go
diff --git a/cmd/sudoku/cmd.go b/cmd/sudoku/cmd.go
@@ -23,8 +23,11 @@ func NewSudokuCommand() *cobra.Command {
 
 func solve() error {
 	// build solver
-	sudoku := NewSudoku()
-	so := solver.NewDeppySolver(sudoku, sudoku)
+	sudoku := &Sudoku{}
+	so, err := solver.NewDeppySolver(sudoku)
+	if err != nil {
+		return err
+	}
 
 	// get solution
 	solution, err := so.Solve(context.Background())

diff --git a/cmd/sudoku/sudoku.go b/cmd/sudoku/sudoku.go
@@ -4,20 +4,16 @@ import (
 	"context"
 	"fmt"
 	"math/rand"
-	"strconv"
 	"time"
 
 	"github.com/operator-framework/deppy/pkg/deppy"
 	"github.com/operator-framework/deppy/pkg/deppy/constraint"
 	"github.com/operator-framework/deppy/pkg/deppy/input"
 )
 
-var _ input.EntitySource = &Sudoku{}
 var _ input.VariableSource = &Sudoku{}
 
-type Sudoku struct {
-	*input.CacheEntitySource
-}
+type Sudoku struct{}
 
 func GetID(row int, col int, num int) deppy.Identifier {
 	n := num
@@ -27,25 +23,10 @@ func GetID(row int, col int, num int) deppy.Identifier {
 }
 
 func NewSudoku() *Sudoku {
-	var entities = make(map[deppy.Identifier]input.Entity, 9*9*9)
-	for row := 0; row < 9; row++ {
-		for col := 0; col < 9; col++ {
-			for num := 0; num < 9; num++ {
-				id := GetID(row, col, num)
-				entities[id] = *input.NewEntity(id, map[string]string{
-					"row": strconv.Itoa(row),
-					"col": strconv.Itoa(col),
-					"num": strconv.Itoa(num),
-				})
-			}
-		}
-	}
-	return &Sudoku{
-		CacheEntitySource: input.NewCacheQuerier(entities),
-	}
+	return &Sudoku{}
 }
 
-func (s Sudoku) GetVariables(_ context.Context, _ input.EntitySource) ([]deppy.Variable, error) {
+func (s Sudoku) GetVariables(ctx context.Context) ([]deppy.Variable, error) {
 	// adapted from: https://github.com/go-air/gini/blob/871d828a26852598db2b88f436549634ba9533ff/sudoku_test.go#L10
 	variables := make(map[deppy.Identifier]*input.SimpleVariable, 0)
 	inorder := make([]deppy.Variable, 0)

diff --git a/pkg/deppy/input/entity.go b/pkg/deppy/input/entity.go
diff --git a/pkg/deppy/input/entity_source.go b/pkg/deppy/input/entity_source.go
diff --git a/pkg/deppy/input/entity_test.go b/pkg/deppy/input/entity_test.go
diff --git a/pkg/deppy/input/query.go b/pkg/deppy/input/query.go
diff --git a/pkg/deppy/input/variable_source.go b/pkg/deppy/input/variable_source.go
@@ -8,7 +8,7 @@ import (
 
 // VariableSource generates solver constraints given an entity querier interface
 type VariableSource interface {
-	GetVariables(ctx context.Context, entitySource EntitySource) ([]deppy.Variable, error)
+	GetVariables(ctx context.Context) ([]deppy.Variable, error)
 }
 
 var _ deppy.Variable = &SimpleVariable{}

diff --git a/pkg/deppy/solver/solver.go b/pkg/deppy/solver/solver.go
@@ -77,21 +77,19 @@ func AddAllVariablesToSolution() Option {
 // DeppySolver is a simple solver implementation that takes an entity source group and a constraint aggregator
 // to produce a Solution (or error if no solution can be found)
 type DeppySolver struct {
-	entitySource   input.EntitySource
 	variableSource input.VariableSource
 }
 
-func NewDeppySolver(entitySource input.EntitySource, variableSource input.VariableSource) *DeppySolver {
+func NewDeppySolver(variableSource input.VariableSource) *DeppySolver {
 	return &DeppySolver{
-		entitySource:   entitySource,
 		variableSource: variableSource,
 	}
 }
 
 func (d DeppySolver) Solve(ctx context.Context, options ...Option) (*Solution, error) {
 	solutionOpts := defaultSolutionOptions().apply(options...)
 
-	vars, err := d.variableSource.GetVariables(ctx, d.entitySource)
+	vars, err := d.variableSource.GetVariables(ctx)
 	if err != nil {
 		return nil, err
 	}