model

package

v1.3.0 Latest Latest Go to latest Published: Nov 15, 2021 License: MIT Imports: 8 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

Repository

github.com/mhoc/xtern-matcher

Links

Open Source Insights

Documentation ¶

Index ¶

type Companies
- func LoadCompanies(filename string) (Companies, error)
- func (c Companies) Find(companyName string) *Company
- func (c Companies) Random() *Company
type Company
- func NewCompany(name string, numberHiring int, students []string) *Company
- func (c Company) Equals(c2 Company) bool
type Match
- func NewMatch(c *Company, s *Student) *Match
- func (m Match) Equals(m2 Match) bool
type Matches
type Student
- func NewStudent(name string, companies []string) *Student
- func (s Student) Equals(s2 Student) bool
type Students
- func LoadStudents(filename string) (Students, error)
- func (s Students) Find(name string) *Student
- func (s Students) Validate() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Companies ¶

type Companies []*Company

func LoadCompanies ¶

func LoadCompanies(filename string) (Companies, error)

func (Companies) Find ¶

func (c Companies) Find(companyName string) *Company

func (Companies) Random ¶

func (c Companies) Random() *Company

type Company ¶

type Company struct {
	Name         string
	NumberHiring int
	Students     []string
}

func NewCompany ¶

func NewCompany(name string, numberHiring int, students []string) *Company

func (Company) Equals ¶

func (c Company) Equals(c2 Company) bool

type Match ¶

type Match struct {
	Company *Company
	Student *Student
}

func NewMatch ¶

func NewMatch(c *Company, s *Student) *Match

func (Match) Equals ¶

func (m Match) Equals(m2 Match) bool

type Matches ¶

type Matches []*Match

func (Matches) Add ¶

func (m Matches) Add(student *Student, company *Company) Matches

func (Matches) CompanyCanSupportMatch ¶

func (m Matches) CompanyCanSupportMatch(company *Company) bool

CompanyCanSupportMatch returns true if a company has room to match

func (Matches) Equals ¶

func (m Matches) Equals(m2 Matches) bool

Equals returns true of two sets of matches are exactly equal to one-another.

func (Matches) FindByStudent ¶

func (m Matches) FindByStudent(student *Student) *Match

FindByStudent finds the student's match in the list of matches, or nil if they haven't been matched yet

func (Matches) StudentHasMatch ¶

func (m Matches) StudentHasMatch(student *Student) bool

StudentHasMatch returns true if the given student has a match already assigned

func (Matches) WriteByCompany ¶

func (m Matches) WriteByCompany()

func (Matches) WriteByStudent ¶

func (m Matches) WriteByStudent()

func (Matches) WriteCSVByCompany ¶

func (m Matches) WriteCSVByCompany()

func (Matches) WriteCSVByStudent ¶

func (m Matches) WriteCSVByStudent()

type Student ¶

type Student struct {
	Name      string
	Companies []string
}

func NewStudent ¶

func NewStudent(name string, companies []string) *Student

func (Student) Equals ¶

func (s Student) Equals(s2 Student) bool

type Students ¶

type Students []*Student

func LoadStudents ¶

func LoadStudents(filename string) (Students, error)

func (Students) Find ¶

func (s Students) Find(name string) *Student

func (Students) Validate ¶

func (s Students) Validate() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL