fleccs

Documentation

Overview

Package fleccs contains a golang re-implementation of the tool "FLeCCS" - "Fragment Level Similar Co-Change Suggester" by Manishankar Mondal, et al., on ICPC 2021. https://ieeexplore.ieee.org/document/9463009

Details may differ.

Index

• Constants
• type Candidate
  • func Search(ctx context.Context, queriesTree domain.Searcher, queries []*Query, ...) ([]*Candidate, error)
• type ConfigFunc
  • func WithContextLines(lines int) ConfigFunc
  • func WithSimilarityThreshold(threshold float64) ConfigFunc
• type Query
• type Source

Constants

const (
	DefaultContextLines        = 4
	DefaultSimilarityThreshold = 0.7
)

Types

type Candidate

type Candidate struct {
	Filename   string
	StartLine  int
	EndLine    int
	Similarity float64
	// Source indicates from which query this co-change candidate was detected
	Source Source
}

func Search

func Search(
	ctx context.Context,
	queriesTree domain.Searcher,
	queries []*Query,
	searchTree domain.Searcher,
	options ...ConfigFunc,
) ([]*Candidate, error)

type ConfigFunc

type ConfigFunc func(c *config)

func WithContextLines

func WithContextLines(lines int) ConfigFunc

func WithSimilarityThreshold

func WithSimilarityThreshold(threshold float64) ConfigFunc

type Query

type Query struct {
	Filename     string
	StartL, EndL int
	// contains filtered or unexported fields
}

type Source

type Source struct {
	Filename     string
	StartL, EndL int
}