org.hipparchus.samples.complex.SawToothModuleValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hipparchus-samples Show documentation

The Hipparchus samples module

The newest version!

/*
 * Licensed to the Hipparchus project under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The Hipparchus project 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
 *
 *      https://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.hipparchus.samples.complex;

import org.hipparchus.complex.Complex;
import org.hipparchus.util.FastMath;

/** Domain coloring enhancing modules changes.
 * 
 * Value represents module but uses a sawtooth function.
 * 
 * 
 * The sawtooth function is computed from a base 2 logarithm and fractional parts.
 * It enhances modules changes with discontinuities and dark rings.
 * 
 */
public class SawToothModuleValue extends DomainColoring {

    /** Simple constructor.
     * @param saturation constant saturation
     */
    protected SawToothModuleValue(final double saturation) {
        super(saturation);
    }

    /** {@inheritDoc} */
    @Override
    public double value(final Complex z) {
        final double module = z.norm();
        return FastMath.log(module) / FastMath.log(2.0);
    }

}