org.apache.mahout.utils.vectors.Weight Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mahout-utils Show documentation

Utilities for preparing content into formats for Mahout.

There is a newer version: 0.5

/**
 * Licensed to the Apache Software Foundation (ASF) 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 org.apache.mahout.utils.vectors;

public interface Weight {
  
  /**
   * Experimental
   * 
   * @param tf term freq
   * @param df doc freq
   * @param length Length of the document
   * @param numDocs the total number of docs
   * @return The weight
   */
  double calculate(int tf, int df, int length, int numDocs);
}