Loading documentation...

Installation

This guide will help you install and set up Synapse in your Go project.

Prerequisites

Before installing Synapse, ensure you have:

Go 1.24+ installed
A Go module initialized in your project (run go mod init if needed)

Installation

Use go get to install Synapse:

go get github.com/kolosys/synapse

This will download the package and add it to your go.mod file.

Available Packages

Synapse includes several packages that you can import based on your needs:

Core Package

The main cache functionality:

import "github.com/kolosys/synapse"

Algorithms Package

Built-in similarity algorithms for string and vector comparisons:

import "github.com/kolosys/synapse/algorithms"

Provides:

Levenshtein - Edit distance for strings
DamerauLevenshtein - Edit distance with transpositions
Hamming / HammingBytes - Hamming distance for equal-length strings/bytes
Euclidean - Euclidean distance for vectors
Manhattan - Manhattan distance for vectors

Eviction Package

Cache eviction policies:

import "github.com/kolosys/synapse/eviction"

Provides:

LRU - Least Recently Used eviction
CombinedPolicy - Combine multiple policies with weighted scoring

Verify Installation

Create a simple test file to verify the installation:

package main

import (
    "context"
    "fmt"

    "github.com/kolosys/synapse"
)

func main() {
    cache := synapse.New[string, string]()
    ctx := context.Background()

    cache.Set(ctx, "hello", "world")
    if value, found := cache.Get(ctx, "hello"); found {
        fmt.Println("Synapse installed successfully:", value)
    }
}

Run the test:

go run main.go

Updating

To update to the latest version:

go get -u github.com/kolosys/synapse

To update to a specific version:

go get github.com/kolosys/synapse@v1.2.3

Development Setup

If you want to contribute or modify the library:

git clone https://github.com/kolosys/synapse.git
cd synapse
go mod download
go test -race ./...

Troubleshooting

Module Not Found

If you encounter a "module not found" error:

Ensure your GOPATH is set correctly
Check that you have network access to GitHub
Try running go clean -modcache and reinstall

Private Repository Access

For private repositories, configure Git to use SSH or a personal access token:

git config --global url."git@github.com:".insteadOf "https://github.com/"

Or set up GOPRIVATE:

export GOPRIVATE=github.com/kolosys/*

Next Steps

Quick Start Guide - Learn how to use Synapse
Core Concepts - Understand the architecture
API Reference - Complete API documentation

Loading documentation...

Installation

This guide will help you install and set up Synapse in your Go project.

Prerequisites

Before installing Synapse, ensure you have:

Go 1.24+ installed
A Go module initialized in your project (run go mod init if needed)

Installation

Use go get to install Synapse:

go get github.com/kolosys/synapse

This will download the package and add it to your go.mod file.

Available Packages

Synapse includes several packages that you can import based on your needs:

Core Package

The main cache functionality:

import "github.com/kolosys/synapse"

Algorithms Package

Built-in similarity algorithms for string and vector comparisons:

import "github.com/kolosys/synapse/algorithms"

Provides:

Levenshtein - Edit distance for strings
DamerauLevenshtein - Edit distance with transpositions
Hamming / HammingBytes - Hamming distance for equal-length strings/bytes
Euclidean - Euclidean distance for vectors
Manhattan - Manhattan distance for vectors

Eviction Package

Cache eviction policies:

import "github.com/kolosys/synapse/eviction"

Provides:

LRU - Least Recently Used eviction
CombinedPolicy - Combine multiple policies with weighted scoring

Verify Installation

Create a simple test file to verify the installation:

package main

import (
    "context"
    "fmt"

    "github.com/kolosys/synapse"
)

func main() {
    cache := synapse.New[string, string]()
    ctx := context.Background()

    cache.Set(ctx, "hello", "world")
    if value, found := cache.Get(ctx, "hello"); found {
        fmt.Println("Synapse installed successfully:", value)
    }
}

Run the test:

go run main.go

Updating

To update to the latest version:

go get -u github.com/kolosys/synapse

To update to a specific version:

go get github.com/kolosys/synapse@v1.2.3

Development Setup

If you want to contribute or modify the library:

git clone https://github.com/kolosys/synapse.git
cd synapse
go mod download
go test -race ./...

Troubleshooting

Module Not Found

If you encounter a "module not found" error:

Ensure your GOPATH is set correctly
Check that you have network access to GitHub
Try running go clean -modcache and reinstall

Private Repository Access

For private repositories, configure Git to use SSH or a personal access token:

git config --global url."git@github.com:".insteadOf "https://github.com/"

Or set up GOPRIVATE:

export GOPRIVATE=github.com/kolosys/*

Next Steps

Quick Start Guide - Learn how to use Synapse
Core Concepts - Understand the architecture
API Reference - Complete API documentation

Loading documentation...

Installation

This guide will help you install and set up Synapse in your Go project.

Prerequisites

Before installing Synapse, ensure you have:

Go 1.24+ installed
A Go module initialized in your project (run go mod init if needed)

Installation

Use go get to install Synapse:

bash

go get github.com/kolosys/synapse

go get github.com/kolosys/synapse

This will download the package and add it to your go.mod file.

Available Packages

Synapse includes several packages that you can import based on your needs:

Core Package

The main cache functionality:

import "github.com/kolosys/synapse"

import "github.com/kolosys/synapse"

Algorithms Package

Built-in similarity algorithms for string and vector comparisons:

import "github.com/kolosys/synapse/algorithms"

import "github.com/kolosys/synapse/algorithms"

Provides:

Levenshtein - Edit distance for strings
DamerauLevenshtein - Edit distance with transpositions
Hamming / HammingBytes - Hamming distance for equal-length strings/bytes
Euclidean - Euclidean distance for vectors
Manhattan - Manhattan distance for vectors

Eviction Package

Cache eviction policies:

import "github.com/kolosys/synapse/eviction"

import "github.com/kolosys/synapse/eviction"

Provides:

LRU - Least Recently Used eviction
CombinedPolicy - Combine multiple policies with weighted scoring

Verify Installation

Create a simple test file to verify the installation:

package main

import (
    "context"
    "fmt"

    "github.com/kolosys/synapse"
)

func main() {
    cache := synapse.New[string, string]()
    ctx := context.Background()

    cache.Set(ctx, "hello", "world")
    if value, found := cache.Get(ctx, "hello"); found {
        fmt.Println("Synapse installed successfully:", value)
    }
}

package main

import (
    "context"
    "fmt"

    "github.com/kolosys/synapse"
)

func main() {
    cache := synapse.New[string, string]()
    ctx := context.Background()

    cache.Set(ctx, "hello", "world")
    if value, found := cache.Get(ctx, "hello"); found {
        fmt.Println("Synapse installed successfully:", value)
    }
}

Run the test:

bash

go run main.go

go run main.go

Updating

To update to the latest version:

bash

go get -u github.com/kolosys/synapse

go get -u github.com/kolosys/synapse

To update to a specific version:

bash

go get github.com/kolosys/synapse@v1.2.3

go get github.com/kolosys/synapse@v1.2.3

Development Setup

If you want to contribute or modify the library:

bash

git clone https://github.com/kolosys/synapse.git
cd synapse
go mod download
go test -race ./...

git clone https://github.com/kolosys/synapse.git
cd synapse
go mod download
go test -race ./...

Troubleshooting

Module Not Found

If you encounter a "module not found" error:

Ensure your GOPATH is set correctly
Check that you have network access to GitHub
Try running go clean -modcache and reinstall

Private Repository Access

For private repositories, configure Git to use SSH or a personal access token:

bash

git config --global url."git@github.com:".insteadOf "https://github.com/"

git config --global url."git@github.com:".insteadOf "https://github.com/"

Or set up GOPRIVATE:

bash

export GOPRIVATE=github.com/kolosys/*

export GOPRIVATE=github.com/kolosys/*

Next Steps

Quick Start Guide - Learn how to use Synapse
Core Concepts - Understand the architecture
API Reference - Complete API documentation

Installation

This guide will help you install and set up Synapse in your Go project.

Prerequisites

Before installing Synapse, ensure you have:

Go 1.24+ installed
A Go module initialized in your project (run go mod init if needed)

Installation

Use go get to install Synapse:

bash

go get github.com/kolosys/synapse

go get github.com/kolosys/synapse

This will download the package and add it to your go.mod file.

Available Packages

Synapse includes several packages that you can import based on your needs:

Core Package

The main cache functionality:

import "github.com/kolosys/synapse"

import "github.com/kolosys/synapse"

Algorithms Package

Built-in similarity algorithms for string and vector comparisons:

import "github.com/kolosys/synapse/algorithms"

import "github.com/kolosys/synapse/algorithms"

Provides:

Levenshtein - Edit distance for strings
DamerauLevenshtein - Edit distance with transpositions
Hamming / HammingBytes - Hamming distance for equal-length strings/bytes
Euclidean - Euclidean distance for vectors
Manhattan - Manhattan distance for vectors

Eviction Package

Cache eviction policies:

import "github.com/kolosys/synapse/eviction"

import "github.com/kolosys/synapse/eviction"

Provides:

LRU - Least Recently Used eviction
CombinedPolicy - Combine multiple policies with weighted scoring

Verify Installation

Create a simple test file to verify the installation:

package main

import (
    "context"
    "fmt"

    "github.com/kolosys/synapse"
)

func main() {
    cache := synapse.New[string, string]()
    ctx := context.Background()

    cache.Set(ctx, "hello", "world")
    if value, found := cache.Get(ctx, "hello"); found {
        fmt.Println("Synapse installed successfully:", value)
    }
}

package main

import (
    "context"
    "fmt"

    "github.com/kolosys/synapse"
)

func main() {
    cache := synapse.New[string, string]()
    ctx := context.Background()

    cache.Set(ctx, "hello", "world")
    if value, found := cache.Get(ctx, "hello"); found {
        fmt.Println("Synapse installed successfully:", value)
    }
}

Run the test:

bash

go run main.go

go run main.go

Updating

To update to the latest version:

bash

go get -u github.com/kolosys/synapse

go get -u github.com/kolosys/synapse

To update to a specific version:

bash

go get github.com/kolosys/synapse@v1.2.3

go get github.com/kolosys/synapse@v1.2.3

Development Setup

If you want to contribute or modify the library:

bash

git clone https://github.com/kolosys/synapse.git
cd synapse
go mod download
go test -race ./...

git clone https://github.com/kolosys/synapse.git
cd synapse
go mod download
go test -race ./...

Troubleshooting

Module Not Found

If you encounter a "module not found" error:

Ensure your GOPATH is set correctly
Check that you have network access to GitHub
Try running go clean -modcache and reinstall

Private Repository Access

For private repositories, configure Git to use SSH or a personal access token:

bash

git config --global url."git@github.com:".insteadOf "https://github.com/"

git config --global url."git@github.com:".insteadOf "https://github.com/"

Or set up GOPRIVATE:

bash

export GOPRIVATE=github.com/kolosys/*

export GOPRIVATE=github.com/kolosys/*

Next Steps

Quick Start Guide - Learn how to use Synapse
Core Concepts - Understand the architecture
API Reference - Complete API documentation