/*
 * ARX Data Anonymization Tool
 * Copyright 2012 - 2024 Fabian Prasser and contributors
 * 
 * Licensed 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 org.deidentifier.arx.risk;

/**
 * Class for risks based on sample uniqueness
 * 
 * @author Fabian Prasser
 */
public class RiskModelSampleUniqueness extends RiskModelSample {

    /**
     * Creates a new instance
     * 
     * @param histogram
     */
    public RiskModelSampleUniqueness(RiskModelHistogram histogram) {
        super(histogram);
    }

    /**
     * Returns the fraction of records affected by the highest re-identification
     * risk
     * 
     * @return
     */
    public double getFractionOfUniqueRecords() {
        if (getHistogram().isEmpty()) {
            return 0d;
        }
        return getNumUniqueRecords() / getHistogram().getNumRecords();
    }

    /**
     * Returns the number of records affected by the lowest re-identification
     * risk
     * 
     * @return
     */
    public double getNumUniqueRecords() {
        if (getHistogram().isEmpty()) {
            return 0d;
        }
        int[] classes = getHistogram().getHistogram();
        return classes[0] == 1 ? classes[1] : 0;
    }
}
