milvus/pkg/util/metric/similarity_corelation_test.go

// Licensed to the LF AI & Data foundation under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package metric

import "testing"

func TestPositivelyRelated(t *testing.T) {
	cases := []struct {
		metricType string
		wanted     bool
	}{
		{
			IP,
			true,
		},
		{
			COSINE,
			true,
		},
		{
			L2,
			false,
		},
		{
			HAMMING,
			false,
		},
		{
			JACCARD,
			false,
		},
		{
			SUBSTRUCTURE,
			false,
		},
		{
			SUPERSTRUCTURE,
			false,
		},
		// MAX_SIM metrics - positively related (higher is better)
		{
			MaxSim,
			true,
		},
		{
			MaxSimIP,
			true,
		},
		{
			MaxSimCosine,
			true,
		},
		// MAX_SIM metrics - negatively related (lower is better)
		{
			MaxSimL2,
			false,
		},
		{
			MaxSimHamming,
			false,
		},
		{
			MaxSimJaccard,
			false,
		},
	}

	for idx := range cases {
		if got := PositivelyRelated(cases[idx].metricType); got != cases[idx].wanted {
			t.Errorf("PositivelyRelated(%v) = %v", cases[idx].metricType, cases[idx].wanted)
		}
	}
}