/*
 * Copyright (c) 2012-2017, Peter Abeles. All Rights Reserved.
 *
 * This file is part of DDogleg (http://ddogleg.org).
 *
 * 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.ddogleg.solver;

import org.ejml.data.Complex_F64;

import java.util.List;

/**
 * Interface for finding the roots of a polynomial. Supports both real and imaginary roots.  Exact behavior is
 * implementation specific.
 *
 * @author Peter Abeles
 */
public interface PolynomialRoots {

	/**
	 * <p>
	 * Finds the roots of the provided polynomial.
	 * </p>
	 *
	 * @param poly Polynomial being considered.  Not modified.
	 * @return true if successful.
	 */
	public boolean process( Polynomial poly );

	/**
	 * Returns all the found roots of the polynomial.
	 *
	 * @return roots
	 */
	public List<Complex_F64> getRoots();
}
