https://github.com/francesconi/go-rampart

Determine how intervals relate to each other.
https://github.com/francesconi/go-rampart

date golang interval overlap time

Last synced: 13 days ago
JSON representation

Determine how intervals relate to each other.

• Host: GitHub
• URL: https://github.com/francesconi/go-rampart
• Owner: francesconi
• License: mit
• Created: 2022-04-08T13:29:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-26T14:20:57.000Z (5 months ago)
• Last Synced: 2024-07-31T20:48:01.968Z (3 months ago)
• Topics: date, golang, interval, overlap, time
• Language: Go
• Homepage: https://pkg.go.dev/github.com/francesconi/go-rampart
• Size: 26.4 KB
• Stars: 99
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-go - go-rampart - Determine how intervals relate to each other. (Data Structures and Algorithms / Miscellaneous Data Structures and Algorithms)
• awesome-ccamel - francesconi/go-rampart - Determine how intervals relate to each other. (Go)
• awesome-go - go-rampart - Determine how intervals relate to each other. (Data Structures and Algorithms / Miscellaneous Data Structures and Algorithms)
• awesome-go-extra - go-rampart - 04-08T13:29:42Z|2022-06-16T11:39:35Z| (Generators / Miscellaneous Data Structures and Algorithms)

README

        
# go-rampart

[![Go Reference](https://pkg.go.dev/badge/github.com/francesconi/go-rampart.svg)](https://pkg.go.dev/github.com/francesconi/go-rampart)

![github.com/francesconi/go-rampart](https://github.com/francesconi/go-rampart/workflows/test/badge.svg)

[![Codecov](https://codecov.io/gh/francesconi/go-rampart/branch/main/graph/badge.svg?token=Y1G145SZB2)](https://codecov.io/gh/francesconi/go-rampart)

[![Go Report Card](https://goreportcard.com/badge/github.com/francesconi/go-rampart)](https://goreportcard.com/report/github.com/francesconi/go-rampart)

Go port of the [Haskell Rampart library](https://github.com/tfausak/rampart) by [Taylor Fausak](https://taylor.fausak.me/2020/03/13/relate-intervals-with-rampart).

This package provides types and functions for defining intervals and determining how they relate to each other. This can be useful to determine if an event happened during a certain time frame, or if two time frames overlap (and if so, how exactly they overlap).

## Install

```sh

go get github.com/francesconi/go-rampart

```

## Examples

### Ordered types

Any type that supports the operators `<` `<=` `>=` `>`.

```go

a := rampart.NewInterval(2, 3)

b := rampart.NewInterval(3, 7)

rel := a.Relate(b)

// rel: RelationMeets

```

### Any other type

`NewIntervalFunc` accepts any type as long as a comparison function is provided. The comparison function should return values as follows:

```go

cmp(t1, t2) < 0 if t1 < t2

cmp(t1, t2) > 0 if t1 > t2

cmp(t1, t2) == 0 if t1 == t2

```

#### time.Time

```go

func compareTimes(t1, t2 time.Time) int {

    return int(t1.Sub(t2))

}

a := rampart.NewIntervalFunc(

    time.Date(2022, time.April, 1, 0, 0, 0, 0, time.UTC),

    time.Date(2022, time.April, 8, 0, 0, 0, 0, time.UTC),

    compareTimes,

)

b := rampart.NewIntervalFunc(

    time.Date(2022, time.April, 6, 0, 0, 0, 0, time.UTC),

    time.Date(2022, time.April, 15, 0, 0, 0, 0, time.UTC),

    compareTimes,

)

rel := a.Relate(b)

// rel: RelationOverlaps

```

![][interval relations]

[interval relations]: ./docs/interval-relations.svg