001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 018 package org.apache.commons.math.distribution; 019 020 /** 021 * The Zipf (or zeta) Distribution. 022 * <p> 023 * References: 024 * <ul> 025 * <li><a href="http://mathworld.wolfram.com/ZipfDistribution.html">Zipf 026 * Distribution</a></li> 027 * </ul> 028 * </p> 029 * 030 * @version $Revision: 920852 $ $Date: 2010-03-09 13:53:44 +0100 (mar. 09 mars 2010) $ 031 */ 032 public interface ZipfDistribution extends IntegerDistribution { 033 034 /** 035 * Get the number of elements (e.g. corpus size) for the distribution. 036 * 037 * @return the number of elements 038 */ 039 int getNumberOfElements(); 040 041 /** 042 * Set the number of elements (e.g. corpus size) for the distribution. 043 * The parameter value must be positive; otherwise an 044 * <code>IllegalArgumentException</code> is thrown. 045 * 046 * @param n the number of elements 047 * @throws IllegalArgumentException if n ≤ 0 048 * @deprecated as of v2.1 049 */ 050 @Deprecated 051 void setNumberOfElements(int n); 052 053 /** 054 * Get the exponent characterising the distribution. 055 * 056 * @return the exponent 057 */ 058 double getExponent(); 059 060 /** 061 * Set the exponent characterising the distribution. 062 * The parameter value must be positive; otherwise an 063 * <code>IllegalArgumentException</code> is thrown. 064 * 065 * @param s the exponent 066 * @throws IllegalArgumentException if s ≤ 0.0 067 * @deprecated as of v2.1 068 */ 069 @Deprecated 070 void setExponent(double s); 071 }